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