X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=BaseTools%2FBuildNotes.txt;h=e2b10fddc3a6536793e4c700fcfe52f58afdddf3;hb=08283b966ea10c0430140dc2b2951d8534d05aaa;hp=05bbd7ca9f19f61a6d558666edf71d9c7584d542;hpb=40d841f6a8f84e75409178e19e69b95e01bada0f;p=mirror_edk2.git diff --git a/BaseTools/BuildNotes.txt b/BaseTools/BuildNotes.txt index 05bbd7ca9f..e2b10fddc3 100644 --- a/BaseTools/BuildNotes.txt +++ b/BaseTools/BuildNotes.txt @@ -6,19 +6,18 @@ Root Package 1.00 Intel is a trademark or registered trademark of Intel Corporation or its subsidiaries in the United States and other countries. * Other names and brands may be claimed as the property of others. -Copyright (c) 2007, Intel Corporation. All rights reserved. +Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved. ------------------------------------------------------------------------------- Quick Start ----------- Windows: - a) Set the PYTHON_FREEZER_PATH to the cx_Freeze installation directory - b) Go to the /BaseTools and run "toolsetup" script + a) Go to the /BaseTools and run "toolsetup" script Unix-like: a) make -C /BaseTools - b) Look over https://edk2.tianocore.org/step-by-step-instructions.html + b) Look over https://github.com/tianocore/tianocore.github.io/wiki/Getting%20Started%20with%20EDK%20II for a helpful step-by-step guide for building 'Hello World' on various operating systems with edk2. @@ -33,28 +32,28 @@ Tools in Python --------------- * Convert Python source to exe file - The tools written in Python can be converted into executable program which can - be executed without installing a Python interpreter. (Generally it is easier + The tools written in Python can be converted into executable program which can + be executed without installing a Python interpreter. (Generally it is easier to run the scripts from their source on operating systems other than Windows.) For Windows and Linux, the conversion tool package is called cx_Freeze, its home page is: - http://sourceforge.net/projects/cx-freeze/ + http://sourceforge.net/projects/cx-freeze/ - If you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use following command + If you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use following command lines to convert MyBuild.py to MyBuild.exe (note this is an example, there is no MyBuild Python project in the BaseTools\Python tree. set PYTHONPATH=\Source\Python - c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_16_le,encodings.utf_8 --install-dir=.\mybuild MyBuild.py + c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_16_le,encodings.utf_8 --install-dir=.\mybuild MyBuild.py - The generated .exe (and .dll) files are put in "mybuild" subdirectory. + The generated .exe (and .dll) files are put in "mybuild" subdirectory. - The following is a real example with the BuildTools/trunk/BaseTools project + The following is a real example with the BuildTools/trunk/BaseTools project installed in: C:\Work\BaseTools - + C:\Work\BaseTools\Source\Python> set PYTHONPATH=C:\Work\BaseTools\Source\Python C:\Work\BaseTools\Source\Python> c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_16_le,encodings.utf_8 --install-dir=C:\Work\BaseTools\Bin\Win32 build\build.py @@ -70,15 +69,15 @@ Windows: The tools written in Python can be executed directly from its source directory as long as the Python interpreter (Python 2.5) has been installed. Before the execution, -please make sure the environment variable PYTHONPATH is set to +please make sure the environment variable PYTHONPATH is set to /BaseTools/Source/Python - There're four tools written in Python. The entrance file of each tool is listed + There're five tools written in Python. The entrance file of each tool is listed below. build /BaseTools/Source/Python/build/build.py GenFds /BaseTools/Source/Python/GenFds/GenFds.py Trim /BaseTools/Source/Python/Trim/Trim.py MigrationMsa2Inf /BaseTools/Source/Python/MigrationMsa2Inf/MigrationMsa2Inf.py - + UPT /BaseTools/Source/Python/UPT/UPT.py