]>
Commit | Line | Data |
---|---|---|
30697b94 MK |
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 | |
a8ae714d | 11 | This directory contains the EDK II build tools and template files.\r |
07a756b9 | 12 | Templates are located in the Conf directory, while the tools executables for\r |
a8ae714d | 13 | Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other\r |
fb0b35e0 | 14 | directory contains tools source.\r |
07a756b9 | 15 | \r |
a8ae714d RC |
16 | Build step to generate the binary tools\r |
17 | ---------------------------------------\r | |
07a756b9 | 18 | \r |
a8ae714d RC |
19 | Windows/Visual Studio Notes\r |
20 | ===========================\r | |
30fdf114 | 21 | \r |
402834d2 LG |
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 | |
30fdf114 | 25 | \r |
a8ae714d | 26 | In addition to this, you should set the following environment variables::\r |
30fdf114 LG |
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 | |
a8ae714d | 30 | (It is the same directory where this README.rst is located.)\r |
30fdf114 LG |
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 | |
a8ae714d RC |
36 | Unix-like operating systems\r |
37 | ===========================\r | |
30fdf114 | 38 | \r |
a8ae714d | 39 | To build on Unix-like operating systems, you only need to type ``make`` in\r |
30fdf114 LG |
40 | the base directory of the project.\r |
41 | \r | |
a8ae714d RC |
42 | Ubuntu Notes\r |
43 | ============\r | |
30fdf114 LG |
44 | \r |
45 | On Ubuntu, the following command should install all the necessary build\r | |
a8ae714d | 46 | packages to build all the C BaseTools::\r |
30fdf114 | 47 | \r |
a8ae714d | 48 | sudo apt install build-essential uuid-dev\r |