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