Change NameGuid to FvFileName
[mirror_edk2.git] / BuildNotes2.txt
index 200bf82..a5d2e3e 100644 (file)
@@ -10,15 +10,19 @@ Copyright (c) 2007, Intel Corporation
 \r
 EDK II Prime packages are in the development phase. They consist of:\r
 \r
-  BuildNotes2.txt    - The build notes for this package\r
-  MdePkg             - Industry-standard headers and libraries\r
-  BaseTools          - Build -specific tools that are designed to help the\r
-                       developer create and modify drivers and libraries\r
-  IntelFrameworkPkg  - Framework headers and libraries\r
-  MdeModulePkg       - Reference drivers\r
-\r
-Currently, only module build supported, and only IA32 architecture supported.\r
+  BuildNotes2.txt         - The build notes for this package\r
+  MdePkg                  - Industry-standard headers and libraries\r
+  BaseTools               - Build -specific tools that are designed to help the\r
+                            developer create and modify drivers and libraries\r
+  IntelFrameworkPkg       - Tiano/Framework Includes and Libraries\r
+  MdeModulePkg            - UEFI 2.1/PI 1.0 compliant modules\r
+  IntelFrameworkModulePKg - Tiano/Framework Includes and Libraries\r
+  Nt32Pkg                 - UEFI 2.1/PI 1.0 emulation environment for Windows\r
+  FatBinPkg               - Binaries built from the FatPkg \r
+  EdkShellBinPkg          - Binaries of full shell, minimum shell and commonds(to be added)\r
 \r
+Note:\r
+  EdkShellBinPkg is supported to support both EDK II build and EDKII Prime build by having several module description files.\r
 \r
 -------------------------------------------------------------------------------\r
 Quick Start\r
@@ -28,7 +32,9 @@ NOTE: Please confirm you have already installed Python on your machine.
 \r
 In a command window, change to the top-level directory of the EDK II source.\r
 \r
-First, set up your workspace\r
+First, set up your workspace. If you have had a setup, please make sure that\r
+you don't have newer *.template in WORKSPACE\BaseTools\Conf. Otherwise remove\r
+*.txt files in WORKSPACE\Conf in advance.\r
     c:\MyWork\edk2\> edksetup newbuild\r
 \r
 Second, go to the module directory (For example, MdeModulePkg\Application\HelloWorld),\r
@@ -48,4 +54,45 @@ and then go to MdePkg\Library\BaseLib directory and build
     c:\MyWork\edk2\> cd MdePkg\Library\BaseLib\r
     c:\MyWork\edk2\> build\r
 \r
+If you want build a platform, ACTIVE_PLATFORM must be set to your desired platform dsc file,\r
+go to directory which must be not a module's directory, and run "build" command.\r
+\r
+-------------------------------------------------------------------------------\r
+Tools in Python\r
+---------------\r
+\r
+* Run buld tool written in Python from source\r
+  The build tool written in Python can be executed from its source directly as long as you\r
+have the Python interpreter (version 2.5) installed. The source of Python code is locating at\r
+\r
+               https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python\r
+\r
+       where:\r
+\r
+               MyBuild.py      - The temporary "build" tool from which the "build.exe" is coming\r
+               AutoGen.py  - Generate AutoGen.c/.h and makefile only\r
+\r
+       "MyBuild.py" steps:\r
+               1. Run "edksetup.bat newbuild"\r
+               2. Set ACTIVE_PLATFORM in WORKSPACE\Conf\r
+               3. Go to platform or module directory\r
+               4. Run "<python_interpreter.exe> <python_source_dir>\MyBuild.py" or "<python_source_dir>\MyBuild.py"\r
+                  directly.\r
+\r
+       "AutoGen.py" steps:\r
+               1. Run "edksetup.bat newbuild"\r
+               2. Set ACTIVE_PLATFORM in WORKSPACE\Conf\r
+               4. Run "<python_interpreter.exe> <python_source_dir>\AutoGen.py" or "<python_source_dir>\AutoGen.py"\r
+\r
+* Convert Python source to exe file\r
+  The tools written in Python can be coverted into executable program which can be executed\r
+without Python interpreter. One of the convertion tools is called cx_Freeze at \r
+\r
+               http://sourceforge.net/projects/cx-freeze/\r
+\r
+       Suppose you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use following command line to convert MyBuild.py\r
+\r
+       c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_8 --install-dir=.\mybuild MyBuild.py\r
+\r
+       The generated .exe files are put in "mybuild" subdirectory.\r
 \r