[mirror_edk2.git] / BaseTools / ReadMe.txt

This directory contains the next generation of EDK II build tools and template files.\r
Templates are located in the Conf directory, while the tools executables for\r
Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory, other \r
directory contatins tools source.\r
\r
1. Build step to generate the binary tools.\r
\r
=== Windows/Visual Studio Notes ===\r
\r
To build the BaseTools, you should run the standard vsvars32.bat script\r
from your preferred Visual Studio installation or you can run get_vsvars.bat\r
to use latest automatically detected version.\r
\r
In addition to this, you should set the following environment variables:\r
\r
 * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree\r
 * BASE_TOOLS_PATH - The directory where the BaseTools source is located.\r
   (It is the same directory where this README.txt is located.)\r
 * PYTHON_FREEZER_PATH - Path to where the python freezer tool is installed\r
\r
After this, you can run the toolsetup.bat file, which is in the same\r
directory as this file.  It should setup the remainder of the environment,\r
and build the tools if necessary.\r
\r
Please also refer to the 'BuildNotes.txt' file for more information on\r
building under Windows.\r
\r
=== Unix-like operating systems ===\r
\r
To build on Unix-like operating systems, you only need to type 'make' in\r
the base directory of the project.\r
\r
=== Ubuntu Notes ===\r
\r
On Ubuntu, the following command should install all the necessary build\r
packages to build all the C BaseTools:\r
\r
  sudo apt-get install build-essential uuid-dev\r
\r
=== Python sqlite3 module ===\r
On Windows, the cx_freeze will not copy the sqlite3.dll to the frozen \r
binary directory (the same directory as build.exe and GenFds.exe). \r
Please copy it manually from <PythonHome>\DLLs.\r
\r
The Python distributed with most recent Linux will have sqlite3 module\r
built in. If not, please install sqlit3 package separately.\r
\r
26-OCT-2011\r
Commit	Line	Data
	1	This directory contains the next generation of EDK II build tools and template files.\r
	2	Templates are located in the Conf directory, while the tools executables for\r
	3	Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory, other \r
	4	directory contatins tools source.\r
	5	\r
	6	1. Build step to generate the binary tools.\r
	7	\r
	8	=== Windows/Visual Studio Notes ===\r
	9	\r
	10	To build the BaseTools, you should run the standard vsvars32.bat script\r
	11	from your preferred Visual Studio installation or you can run get_vsvars.bat\r
	12	to use latest automatically detected version.\r
	13	\r
	14	In addition to this, you should set the following environment variables:\r
	15	\r
	16	* EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree\r
	17	* BASE_TOOLS_PATH - The directory where the BaseTools source is located.\r
	18	(It is the same directory where this README.txt is located.)\r
	19	* PYTHON_FREEZER_PATH - Path to where the python freezer tool is installed\r
	20	\r
	21	After this, you can run the toolsetup.bat file, which is in the same\r
	22	directory as this file. It should setup the remainder of the environment,\r
	23	and build the tools if necessary.\r
	24	\r
	25	Please also refer to the 'BuildNotes.txt' file for more information on\r
	26	building under Windows.\r
	27	\r
	28	=== Unix-like operating systems ===\r
	29	\r
	30	To build on Unix-like operating systems, you only need to type 'make' in\r
	31	the base directory of the project.\r
	32	\r
	33	=== Ubuntu Notes ===\r
	34	\r
	35	On Ubuntu, the following command should install all the necessary build\r
	36	packages to build all the C BaseTools:\r
	37	\r
	38	sudo apt-get install build-essential uuid-dev\r
	39	\r
	40	=== Python sqlite3 module ===\r
	41	On Windows, the cx_freeze will not copy the sqlite3.dll to the frozen \r
	42	binary directory (the same directory as build.exe and GenFds.exe). \r
	43	Please copy it manually from <PythonHome>\DLLs.\r
	44	\r
	45	The Python distributed with most recent Linux will have sqlite3 module\r
	46	built in. If not, please install sqlit3 package separately.\r
	47	\r
	48	26-OCT-2011\r