Moved tool_setup scripts to Source directory, added BuildNotes.txt and toolsetup...
[people/mcb30/basetools.git] / BuildNotes.txt
1 Intel(R) Platform Innovation Framework for EFI\r
2 BuildTools Project, BaseTools Sub-Project\r
3 Root Package 1.00\r
4 2007-08-31\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 -------------------------------------------------------------------------------\r
12 Quick Start\r
13 -----------\r
14   Set the EDK_TOOLS_PATH to be the root directory of the tools (the root\r
15   directory contains the Bin\ directory.)\r
16 \r
17 Supported build targets\r
18 -----------------------\r
19 \r
20 all                             - Incremental Build of all C based tools. This is the default target\r
21 clean     - Clean intermediate files\r
22 cleanall  - Clean all generated files and directories during build\r
23 \r
24 -------------------------------------------------------------------------------\r
25 \r
26 Tools in Python\r
27 ---------------\r
28 * Convert Python source to exe file\r
29   The tools written in Python can be coverted into executable program which can \r
30   be executed without installing a Python interpreter. \r
31 \r
32   For Windows and Linux, the convertion tool package is called cx_Freeze, its\r
33   home page is:\r
34 \r
35       \r
36 \r
37         If you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use following command\r
38   lines to convert to MyBuild.exe (note this is an example, there is\r
39   no MyBuild Python project in the BaseTools\Python tree.\r
40 \r
41     set PYTHONPATH=<BaseToolsDirPath>\Source\Python\r
42         c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_8 --install-dir=.\mybuild\r
43 \r
44         The generated .exe (and .dll) files are put in "mybuild" subdirectory.\r
45 \r
46   The following is a real example with the BuildTools/trunk/BaseTools project \r
47   installed in: C:\Work\BaseTools\r
48 \r
49   \r
50   C:\Work\BaseTools\Source\Python> set PYTHONPATH=C:\Work\BaseTools\Source\Python\r
51   C:\Work\BaseTools\Source\Python> c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_8 --install-dir=C:\Work\BaseTools\Bin\Win32 build\\r