X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=BaseTools%2FReadMe.txt;h=82b3d5883f72cdeb9f9e362a6a7791851a871b89;hb=e83c843bbdc78e01adefe209e57afc756ca66a00;hp=f461f05be10a5c23c7669cfbd770676cf0a62706;hpb=46d665d690debcc976e109dd88374a9696463fcb;p=mirror_edk2.git

diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt
index f461f05be1..82b3d5883f 100644
--- 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.
 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.
+Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory, other 
+directory contatins tools source.
 
-The binary tools will be updated only after passing developer testing.
+1. Build step to generate the binary tools.
 
-The BaseTools package will be updated with new tools only after all testing on a set
-of binary tools has successfully completed.
+=== Windows/Visual Studio Notes ===
+
+To build the BaseTools, you should run the standard vsvars32.bat script.
+
+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-essentials 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 <PythonHome>\DLLs.
+
+The Python distributed with most recent Linux will have sqlite3 module
+built in. If not, please install sqlit3 package separately.
+
+2. The binary tools will be updated only after passing developer testing.
 
 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.
 
+3. Tool usage introduction.
 BaseTools Simple Usage:
 1) Change the directory to the EDK2 root directory, where the edksetup.bat is
 2) Run "edksetup.bat NewBuild"
@@ -26,19 +65,9 @@ Notes:
    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.
-3) build.exe in %WORKSPACE%\BaseTools\Bin\Win32 is generated from following revision of
-   Python source code:
-        r729 <buildtools_project>\BaseTools\Source\Python\Autogen
-        r729 <buildtools_project>\BaseTools\Source\Python\build
-        r729 <buildtools_project>\BaseTools\Source\Python\Common
-        r729 <buildtools_project>\BaseTools\Source\Python\CommonDataClass
-        r729 <buildtools_project>\BaseTools\Source\Python\GenFds
-        
-4) GenFds.exe has is a combo of the follow python source.(This is a temporary branch)
-        r729 <buildtools_project>\BaseTools\Source\Python\Common
-        r729 <buildtools_project>\BaseTools\Source\Python\CommonDataClass
-        r729 <buildtools_project>\BaseTools\Source\Python\GenFds
-	
+3) All .exe binary file including C and python tools are generated from:
+    r1707 <buildtools_project>\BaseTools\Source\ + r1707 VfrCompiler tool update
+
 Brief usage for Migration Tool MigrationMsa2Inf.exe:
 1. Command line format:
   MigrationMsa2Inf [options]
@@ -121,4 +150,44 @@ It searches all INF, DEC and DSC file under <directory_name> and update them wit
       PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf
    }
 
-30-August-2007
+Brief usage for Migration Tool Spd2Dec.exe:
+1. Command line format:
+  Spd2Dec [options] input_filename
+2. Input File:
+  A syntactically valid SPD file
+3. Output Files:
+  A DEC file whose syntax confirms to DEC spec.
+     
+4. Example:
+   a. Spd2Dec -o c:\work\EdkII\Nt32Pkg\Nt32.spd c:\work\EdkII\Nt32Pkg\Nt32.dec
+   b. Spd2Dec -a c:\work\EdkII\Nt32Pkg\Nt32.spd
+   Example a & b are equivalent to migrate Nt32 package SPD file from EDKII to EDKII' snytax.
+  
+6. Pyton Source
+   r777 <buildtools_project>\BaseTools\Source\Python\spd2Dec
+
+Brief usage for Migration Tool Fpd2Dsc.exe:
+1. Command line format:
+  Fpd2Dsc [options] input_filename
+2. Input File:
+  A syntactically valid FPD file
+3. Output Files:
+  A DSC file which syntax confirms to DSC spec.
+4. Prerequisite:
+   a. The workspace directory must be specified either by environment variable or -w option.
+     
+5. Example:
+   WORKSAPCE has already been set: $(WORKSPACE) = c:\work\EdkII. 
+ 
+   a. Fpd2Dsc -o c:\work\EdkII\Nt32Pkg\Nt32.dsc c:\work\EdkII\Nt32Pkg\Nt32.fpd
+   b. Fpd2Dsc -a c:\work\EdkII\Nt32Pkg\Nt32.fpd
+   Example a & b are equivalent to migrate Nt32 platform description file from EDKII to EDKII' snytax.
+  
+6. Known Limitations:
+   a. Tool does not handle Libraries Section since no related info in original FPD file. Developers need  to handle it manually in the output DSC file.
+   b. If MSA file which is corresponds to module guid could not be found in currect workspace, tool will dump the module guid.
+ 
+7. Pyton Source
+   r767 <buildtools_project>\BaseTools\Source\Python\Fpd2Dsc
+
+10-Sep-2009