BaseTools/ReadMe.txt

   1 This directory contains the next generation of EDK II build tools and template files.
   2 Templates are located in the Conf directory, while the tools executables for
   3 Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory, other
   4 directory contatins tools source.
   5
   6 1. Build step to generate the binary tools.
   7
   8 === Windows/Visual Studio Notes ===
   9
  10 To build the BaseTools, you should run the standard vsvars32.bat script.
  11
  12 In addition to this, you should set the following environment variables:
  13
  14  * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree
  15  * BASE_TOOLS_PATH - The directory where the BaseTools source is located.
  16    (It is the same directory where this README.txt is located.)
  17  * PYTHON_FREEZER_PATH - Path to where the python freezer tool is installed
  18
  19 After this, you can run the toolsetup.bat file, which is in the same
  20 directory as this file.  It should setup the remainder of the environment,
  21 and build the tools if necessary.
  22
  23 Please also refer to the 'BuildNotes.txt' file for more information on
  24 building under Windows.
  25
  26 === Unix-like operating systems ===
  27
  28 To build on Unix-like operating systems, you only need to type 'make' in
  29 the base directory of the project.
  30
  31 === Ubuntu Notes ===
  32
  33 On Ubuntu, the following command should install all the necessary build
  34 packages to build all the C BaseTools:
  35
  36   sudo apt-get install build-essentials uuid-dev
  37
  38 === Python sqlite3 module ===
  39 On Windows, the cx_freeze will not copy the sqlite3.dll to the frozen
  40 binary directory (the same directory as build.exe and GenFds.exe).
  41 Please copy it manually from <PythonHome>\DLLs.
  42
  43 The Python distributed with most recent Linux will have sqlite3 module
  44 built in. If not, please install sqlit3 package separately.
  45
  46 2. The binary tools will be updated only after passing developer testing.
  47
  48 Current state of the tools is Proto-Type - not all tool functions have been implemented
  49 and there may be bugs in these tools.  These tools are under constant development at
  50 this time.
  51
  52 26-OCT-2011