Note: New build instructions are available. It is recommended to start with the new instructions if learning how to        build edk2 for the first time. This page is retained for reference.

New instructions:Build Instructions

GitHub (https://help.github.com/index.html) provides step-by-step instructions for user registration and basic features supported by GitHub

• Setup GitHub for Linux | Windows | MAC | All (https://help.github.com/articles/set-up-git)
• To download and install a Git GUI interface (http://git-scm.com/)

• The EDK II BaseTools are part of the EDK II project repository.
• The EDK II project repository is available athttps://github.com/tianocore/edk2.
• Prebuilt Windows tools are available athttps://github.com/tianocore/edk2-BaseTools-win32.
• Content that is not released under an accepted open source license can be found athttps://github.com/tianocore/edk2-non-osi.
  

For both the BuildTools andEDK II projects, you will need to obtain a compiler from somewhere else. These instructions do not cover obtaining or installation of a compiler tools chain. The BaseTools build requires a C compiler; an assembler or ACPI assembler are not required to build tools in this project. BaseTools assume that a compiler is already configured in the environment.

The BaseTools build supports the Makefile based build for EDK II. All Tools are written in either C or Python. The C tools must compile on all operating systems with various compilers, so the code is written using simple, standard functions and libraries. The Python-based tools are written assuming the features that were available in Python. GUI applications can be created in Python, using the wxPython package and all Python applications can be converted to run under a native OS (Windows, Linux or OS/X.) via thePython Tools.

The tools in this section are NOT required to build the EDK II project; they are needed to compile theBaseTools used to build the EDK II project.

• Linux and OS/X developers using a command line, create a directory that will be used to hold the files, then change to that directory.
  • Replace URL with apropriate one fromPython Tools. Installation and configuration for these tools are left to the developer.

Refer to documentation in either the UserManuals or Source folders for more information.

• BuildToolsUser Manuals

SeeGetting Started with EDK II

After setting up your build environment seeEDK II Development Process for making contributions to the EDK II Project.

If you have questions about the code or run into obstacles getting things to work for you, please join ouredk2-devel email list and ask your EDK II related questions on the list.