[mirror_edk2.git] / BaseTools / ReadMe.rst

::\r
\r
  Note: New build instructions are available. It is recommended to start with\r
  the new instructions if learning how to build edk2 and/or BaseTools for the\r
  first time. This page is retained for reference.\r
\r
New instructions: `Build Instructions`_\r
\r
.. _`Build Instructions`: https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions\r
\r
This directory contains the EDK II build tools and template files.\r
Templates are located in the Conf directory, while the tools executables for\r
Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other\r
directory contains tools source.\r
\r
Build step to generate the binary tools\r
---------------------------------------\r
\r
Windows/Visual Studio Notes\r
===========================\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.rst is located.)\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
Unix-like operating systems\r
===========================\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
\r
On Ubuntu, the following command should install all the necessary build\r
packages to build all the C BaseTools::\r
\r
 sudo apt install build-essential uuid-dev\r
Commit	Line	Data
	1	::\r
	2	\r
	3	Note: New build instructions are available. It is recommended to start with\r
	4	the new instructions if learning how to build edk2 and/or BaseTools for the\r
	5	first time. This page is retained for reference.\r
	6	\r
	7	New instructions: `Build Instructions`_\r
	8	\r
	9	.. _`Build Instructions`: https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions\r
	10	\r
	11	This directory contains the EDK II build tools and template files.\r
	12	Templates are located in the Conf directory, while the tools executables for\r
	13	Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other\r
	14	directory contains tools source.\r
	15	\r
	16	Build step to generate the binary tools\r
	17	---------------------------------------\r
	18	\r
	19	Windows/Visual Studio Notes\r
	20	===========================\r
	21	\r
	22	To build the BaseTools, you should run the standard vsvars32.bat script\r
	23	from your preferred Visual Studio installation or you can run get_vsvars.bat\r
	24	to use latest automatically detected version.\r
	25	\r
	26	In addition to this, you should set the following environment variables::\r
	27	\r
	28	* EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree\r
	29	* BASE_TOOLS_PATH - The directory where the BaseTools source is located.\r
	30	(It is the same directory where this README.rst is located.)\r
	31	\r
	32	After this, you can run the toolsetup.bat file, which is in the same\r
	33	directory as this file. It should setup the remainder of the environment,\r
	34	and build the tools if necessary.\r
	35	\r
	36	Unix-like operating systems\r
	37	===========================\r
	38	\r
	39	To build on Unix-like operating systems, you only need to type ``make`` in\r
	40	the base directory of the project.\r
	41	\r
	42	Ubuntu Notes\r
	43	============\r
	44	\r
	45	On Ubuntu, the following command should install all the necessary build\r
	46	packages to build all the C BaseTools::\r
	47	\r
	48	sudo apt install build-essential uuid-dev\r