audk/BaseTools
Michael Kubacki 30697b94fd BaseTools: Add reference to new build instructions
Adds a reference to the new build instructions on the TianoCore wiki
that currently describe building with containers and Stuart.

Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Acked-by: Ard Biesheuvel <ardb@kernel.org>
Reviewed-by: Gerd Hoffmann <kraxel@redhat.com>
2022-12-16 22:17:18 +00:00
..
Bin BaseTools: Enable LoongArch64 architecture for LoongArch64 EDK2 CI. 2022-10-14 02:16:33 +00:00
BinPipWrappers
BinWrappers
Conf remove GCC build warning 2022-10-24 06:21:08 +00:00
Plugin BaseTools/Plugin/HostBaseUnitTestRunner: Enable gtest xml output 2022-11-11 05:46:51 +00:00
Scripts BaseTools/Scripts/PatchCheck.py: Allow tab in Makefile 2022-10-22 07:01:41 +00:00
Source BaseTools: Fix wrong type of arguments to formatting functions 2022-11-09 14:53:10 +00:00
Tests BaseTools/Tests: Use quotes around PYTHON_COMMAND 2022-10-24 13:04:40 +00:00
UserManuals
.gitignore
BuildEnv
Edk2ToolsBuild.py BaseTools: Edk2ToolsBuild: Fixing pipeline build due to path too long 2022-09-22 12:23:20 +00:00
GNUmakefile
Makefile
ReadMe.rst BaseTools: Add reference to new build instructions 2022-12-16 22:17:18 +00:00
basetools_calling_path_env.yaml
basetools_path_env.yaml
get_vsvars.bat
set_vsprefix_envs.bat
toolsetup.bat

ReadMe.rst

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

::

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

New instructions: `Build Instructions`_

.. _`Build Instructions`: https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions

This directory contains the EDK II build tools and template files.
Templates are located in the Conf directory, while the tools executables for
Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other
directory contains tools source.

Build step to generate the binary tools
---------------------------------------

Windows/Visual Studio Notes
===========================

To build the BaseTools, you should run the standard vsvars32.bat script
from your preferred Visual Studio installation or you can run get_vsvars.bat
to use latest automatically detected version.

In addition to this, you should set the following environment variables::

 * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree
 * BASE_TOOLS_PATH - The directory where the BaseTools source is located.
   (It is the same directory where this README.rst is located.)

After this, you can run the toolsetup.bat file, which is in the same
directory as this file.  It should setup the remainder of the environment,
and build the tools if necessary.

Unix-like operating systems
===========================

To build on Unix-like operating systems, you only need to type ``make`` in
the base directory of the project.

Ubuntu Notes
============

On Ubuntu, the following command should install all the necessary build
packages to build all the C BaseTools::

 sudo apt install build-essential uuid-dev