]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/ReadMe.rst
ArmVirtPkg: Add reference to new build instructions
[mirror_edk2.git] / BaseTools / ReadMe.rst
CommitLineData
a8ae714d 1This directory contains the EDK II build tools and template files.\r
07a756b9 2Templates are located in the Conf directory, while the tools executables for\r
a8ae714d 3Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other\r
fb0b35e0 4directory contains tools source.\r
07a756b9 5\r
a8ae714d
RC
6Build step to generate the binary tools\r
7---------------------------------------\r
07a756b9 8\r
a8ae714d
RC
9Windows/Visual Studio Notes\r
10===========================\r
30fdf114 11\r
402834d2
LG
12To build the BaseTools, you should run the standard vsvars32.bat script\r
13from your preferred Visual Studio installation or you can run get_vsvars.bat\r
14to use latest automatically detected version.\r
30fdf114 15\r
a8ae714d 16In addition to this, you should set the following environment variables::\r
30fdf114
LG
17\r
18 * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree\r
19 * BASE_TOOLS_PATH - The directory where the BaseTools source is located.\r
a8ae714d 20 (It is the same directory where this README.rst is located.)\r
30fdf114
LG
21\r
22After this, you can run the toolsetup.bat file, which is in the same\r
23directory as this file. It should setup the remainder of the environment,\r
24and build the tools if necessary.\r
25\r
a8ae714d 26Please also refer to the ``BuildNotes.txt`` file for more information on\r
30fdf114
LG
27building under Windows.\r
28\r
a8ae714d
RC
29Unix-like operating systems\r
30===========================\r
30fdf114 31\r
a8ae714d 32To build on Unix-like operating systems, you only need to type ``make`` in\r
30fdf114
LG
33the base directory of the project.\r
34\r
a8ae714d
RC
35Ubuntu Notes\r
36============\r
30fdf114
LG
37\r
38On Ubuntu, the following command should install all the necessary build\r
a8ae714d 39packages to build all the C BaseTools::\r
30fdf114 40\r
a8ae714d 41 sudo apt install build-essential uuid-dev\r