Check In tool source code based on Build tool project revision r1655.

[mirror_edk2.git] / BaseTools / ReadMe.txt

diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt
index 0345aa5f509b22b7ba0e1a1fdcdede75084b6261..e47f465a7a733e915d627b2de59279a08671bf56 100644 (file)
--- a/BaseTools/ReadMe.txt
+++ b/BaseTools/ReadMe.txt
@@ -1,16 +1,55 @@
 This directory contains the next generation of EDK II build tools and template files.\r
 Templates are located in the Conf directory, while the tools executables for\r
 This directory contains the next generation of EDK II build tools and template files.\r
 Templates are located in the Conf directory, while the tools executables for\r

-Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory.\r
+Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory, other \r
+directory contatins tools source.\r

 \r
 \r

-The binary tools will be updated only after passing developer testing.\r
+1. Build step to generate the binary tools.\r

 \r
 \r

-The BaseTools package will be updated with new tools only after all testing on a set\r
-of binary tools has successfully completed.\r
+=== Windows/Visual Studio Notes ===\r
+\r
+To build the BaseTools, you should run the standard vsvars32.bat script.\r
+\r
+In addition to this, you should set the following environment variables:\r
+\r
+ * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree\r
+ * BASE_TOOLS_PATH - The directory where the BaseTools source is located.\r
+   (It is the same directory where this README.txt is located.)\r
+ * PYTHON_FREEZER_PATH - Path to where the python freezer tool is installed\r
+\r
+After this, you can run the toolsetup.bat file, which is in the same\r
+directory as this file.  It should setup the remainder of the environment,\r
+and build the tools if necessary.\r
+\r
+Please also refer to the 'BuildNotes.txt' file for more information on\r
+building under Windows.\r
+\r
+=== Unix-like operating systems ===\r
+\r
+To build on Unix-like operating systems, you only need to type 'make' in\r
+the base directory of the project.\r
+\r
+=== Ubuntu Notes ===\r
+\r
+On Ubuntu, the following command should install all the necessary build\r
+packages to build all the C BaseTools:\r
+\r
+  sudo apt-get install build-essentials uuid-dev\r
+\r
+=== Python sqlite3 module ===\r
+On Windows, the cx_freeze will not copy the sqlite3.dll to the frozen \r
+binary directory (the same directory as build.exe and GenFds.exe). \r
+Please copy it manually from <PythonHome>\DLLs.\r
+\r
+The Python distributed with most recent Linux will have sqlite3 module\r
+built in. If not, please install sqlit3 package separately.\r
+\r
+2. The binary tools will be updated only after passing developer testing.\r

 \r
 Current state of the tools is Proto-Type - not all tool functions have been implemented\r
 and there may be bugs in these tools.  These tools are under constant development at\r
 this time.\r
 \r
 \r
 Current state of the tools is Proto-Type - not all tool functions have been implemented\r
 and there may be bugs in these tools.  These tools are under constant development at\r
 this time.\r
 \r

+3. Tool usage introduction.\r

 BaseTools Simple Usage:\r
 1) Change the directory to the EDK2 root directory, where the edksetup.bat is\r
 2) Run "edksetup.bat NewBuild"\r
 BaseTools Simple Usage:\r
 1) Change the directory to the EDK2 root directory, where the edksetup.bat is\r
 2) Run "edksetup.bat NewBuild"\r


@@ -151,4 +190,4 @@ Brief usage for Migration Tool Fpd2Dsc.exe:
 7. Pyton Source\r
    r767 <buildtools_project>\BaseTools\Source\Python\Fpd2Dsc\r
 \r
 7. Pyton Source\r
    r767 <buildtools_project>\BaseTools\Source\Python\Fpd2Dsc\r
 \r

-27-September-2007\r
+17-July-2009\r