Update the release notes:
[mirror_edk2.git] / BuildNotes2.txt
CommitLineData
e4d8dbc9 1Intel(R) Platform Innovation Framework for EFI\r
2EFI Development Kit II Prime (EDK II Prime)\r
3Root Package 1.00\r
42007-06-25\r
5\r
6Intel is a trademark or registered trademark of Intel Corporation or its\r
7subsidiaries in the United States and other countries.\r
8* Other names and brands may be claimed as the property of others.\r
9Copyright (c) 2007, Intel Corporation\r
10\r
11EDK II Prime packages are in the development phase. They consist of:\r
12\r
f91b9b30 13 BuildNotes2.txt - The build notes for this package\r
14 MdePkg - Industry-standard headers and libraries\r
15 BaseTools - Build -specific tools that are designed to help the\r
16 developer create and modify drivers and libraries\r
17 IntelFrameworkPkg - Tiano/Framework Includes and Libraries\r
18 MdeModulePkg - UEFI 2.1/PI 1.0 compliant modules\r
19 IntelFrameworkModulePKg - Tiano/Framework Includes and Libraries\r
20 Nt32Pkg - UEFI 2.1/PI 1.0 emulation environment for Windows\r
21 FatBinPkg - Binaries built from the FatPkg \r
22 EdkShellBinPkg - Binaries of full shell, minimum shell and commonds(to be added)\r
23\r
24Note:\r
25 EdkShellBinPkg is supported to support both EDK II build and EDKII Prime build by having several module description files.\r
e4d8dbc9 26\r
27-------------------------------------------------------------------------------\r
28Quick Start\r
29-----------\r
30\r
31NOTE: Please confirm you have already installed Python on your machine.\r
32\r
33In a command window, change to the top-level directory of the EDK II source.\r
34\r
11dd6c39 35First, set up your workspace. If you have had a setup, please make sure that\r
36you don't have newer *.template in WORKSPACE\BaseTools\Conf. Otherwise remove\r
37*.txt files in WORKSPACE\Conf in advance.\r
e4d8dbc9 38 c:\MyWork\edk2\> edksetup newbuild\r
39\r
40Second, go to the module directory (For example, MdeModulePkg\Application\HelloWorld),\r
41and then begin to build\r
42 c:\MyWork\edk2\> cd MdeModulePkg\Application\HelloWorld\r
43 c:\MyWork\edk2\> build\r
44\r
45If you want to build the modules in other packages\r
46(For example, MdePkg\Library\BaseLib\BaseLib.inf), please edit open the BaseTools\Conf\Target.txt firstly,\r
47\r
48change the following line\r
49 ACTIVE_PLATFORM = MdeModulePkg/MdeModulePkg.dsc\r
50to\r
51 ACTIVE_PLATFORM = MdePkg/MdePkg.dsc\r
52\r
53and then go to MdePkg\Library\BaseLib directory and build\r
54 c:\MyWork\edk2\> cd MdePkg\Library\BaseLib\r
55 c:\MyWork\edk2\> build\r
56\r
d57e875c 57If you want build a platform, ACTIVE_PLATFORM must be set to your desired platform dsc file,\r
11dd6c39 58go to directory which must be not a module's directory, and run "build" command.\r
59\r
60-------------------------------------------------------------------------------\r
61Tools in Python\r
62---------------\r
63\r
64* Run buld tool written in Python from source\r
65 The build tool written in Python can be executed from its source directly as long as you\r
66have the Python interpreter (version 2.5) installed. The source of Python code is locating at\r
67\r
68 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python\r
69\r
70 where:\r
71\r
72 MyBuild.py - The temporary "build" tool from which the "build.exe" is coming\r
73 AutoGen.py - Generate AutoGen.c/.h and makefile only\r
74\r
75 "MyBuild.py" steps:\r
76 1. Run "edksetup.bat newbuild"\r
77 2. Set ACTIVE_PLATFORM in WORKSPACE\Conf\r
78 3. Go to platform or module directory\r
79 4. Run "<python_interpreter.exe> <python_source_dir>\MyBuild.py" or "<python_source_dir>\MyBuild.py"\r
80 directly.\r
81\r
82 "AutoGen.py" steps:\r
83 1. Run "edksetup.bat newbuild"\r
84 2. Set ACTIVE_PLATFORM in WORKSPACE\Conf\r
85 4. Run "<python_interpreter.exe> <python_source_dir>\AutoGen.py" or "<python_source_dir>\AutoGen.py"\r
86\r
87* Convert Python source to exe file\r
88 The tools written in Python can be coverted into executable program which can be executed\r
89without Python interpreter. One of the convertion tools is called cx_Freeze at \r
90\r
91 http://sourceforge.net/projects/cx-freeze/\r
92\r
93 Suppose you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use following command line to convert MyBuild.py\r
94\r
d57e875c 95 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
11dd6c39 96\r
97 The generated .exe files are put in "mybuild" subdirectory.\r
e4d8dbc9 98\r