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