X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=BaseTools%2FReadMe.txt;h=be9ff2af856673b193e2e75d51a99f45438e06f9;hp=55fb4083b3af8f3df06cce3a6051d69fce9b9249;hb=584e5cbb3350f988b60feaba0b4264872d228e51;hpb=c7f7ef1e1872147c6b773db519d310af5befc8f0 diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt index 55fb4083b3..be9ff2af85 100644 --- a/BaseTools/ReadMe.txt +++ b/BaseTools/ReadMe.txt @@ -1,36 +1,48 @@ This directory contains the next generation of EDK II build tools and template files. Templates are located in the Conf directory, while the tools executables for -Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory. - -The binary tools will be updated only after passing developer testing. - -The BaseTools package will be updated with new tools only after all testing on a set -of binary tools has successfully completed. - -Current state of the tools is Proto-Type - not all tool functions have been implemented -and there may be bugs in these tools. These tools are under constant development at -this time. - -BaseTools Simple Usage: -1) Change the directory to the EDK2 root directory, where the edksetup.bat is -2) Run "edksetup.bat NewBuild" -3) Set the ACTIVE_PLATFORM to your desired platform description file - (%WORKSPACE%\Conf\target.txt) -4) To build platform, run "build" command in non-module directory -5) To build module individually, run "build" command in module directory, i.e. where the - *.inf file is - -Notes: -1) Only *.efi files can be generated. Flash image cannot be generated at present. -2) Only "clean" and "cleanall" build target are supported, in both top level - makefile and module's makefile. -3) Not all tool chains and target architectures are tested. Due to both tools - and source code limitations, ther must be bugs in it. Please report any issue - ASAP so we can fix it soon. -4) The tree structure generated by build tools is similar to Ant build system. -5) Makefile can be called directly by nmake for both top level platform and module. But - after you call "nmake cleanall", you have to call "build" command to rebuild platform - or modules because the AutoGen.* files have been be removed. The "makefile" itself - cannot generate AutoGen.* files. Only "build" command can. - -25-Jun-2007 +Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory, other +directory contatins tools source. + +1. 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.txt is located.) + * PYTHON_FREEZER_PATH - Path to where the python freezer tool is installed + +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. + +Please also refer to the 'BuildNotes.txt' file for more information on +building under Windows. + +=== 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-get install build-essential uuid-dev + +=== Python sqlite3 module === +On Windows, the cx_freeze will not copy the sqlite3.dll to the frozen +binary directory (the same directory as build.exe and GenFds.exe). +Please copy it manually from \DLLs. + +The Python distributed with most recent Linux will have sqlite3 module +built in. If not, please install sqlit3 package separately. + +26-OCT-2011