Moved some content out of top level of the schema into local sections.
[people/mcb30/basetools.git] / BuildNotes.txt
index 39f9f27..08e4838 100644 (file)
@@ -11,11 +11,19 @@ Copyright (c) 2007, Intel Corporation
 -------------------------------------------------------------------------------\r
 Quick Start\r
 -----------\r
+\r
+Windows:\r
   a) Set the PYTHON_FREEZER_PATH to the cx_Freeze installation directory\r
   b) Go to the <buildtools_project>/BaseTools and run "toolsetup" script\r
 \r
-Supported build targets\r
------------------------\r
+Unix-like:\r
+  a) make -C <buildtools_project>/BaseTools\r
+  b) Look over https://edk2.tianocore.org/step-by-step-instructions.html\r
+     for a helpful step-by-step guide for building 'Hello World' on\r
+     various operating systems with edk2.\r
+\r
+Supported build targets (toolsetup)\r
+-----------------------------------\r
 \r
 build(or none)  - Incremental Build of all C based tools. This is the default target\r
 rebuild         - Clean all generated files and directories during build, and rebuild all tools\r
@@ -24,10 +32,12 @@ rebuild         - Clean all generated files and directories during build, and re
 Tools in Python\r
 ---------------\r
 * Convert Python source to exe file\r
-  The tools written in Python can be coverted into executable program which can \r
-  be executed without installing a Python interpreter. \r
 \r
-  For Windows and Linux, the convertion tool package is called cx_Freeze, its\r
+  The tools written in Python can be converted into executable program which can \r
+  be executed without installing a Python interpreter.  (Generally it is easier\r
+  to run the scripts from their source on operating systems other than Windows.)\r
+\r
+  For Windows and Linux, the conversion tool package is called cx_Freeze, its\r
   home page is:\r
 \r
                http://sourceforge.net/projects/cx-freeze/\r
@@ -48,8 +58,17 @@ Tools in Python
   C:\Work\BaseTools\Source\Python> set PYTHONPATH=C:\Work\BaseTools\Source\Python\r
   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\build.py\r
 \r
-* Execute tools written in Python without convertion\r
-  The tools written in Python can be executely directly from its source directory\r
+---------------\r
+* Execute tools written in Python without conversion\r
+\r
+Unix-like systems:\r
+\r
+The edk2/edksetup.sh script will setup everything which is needed to\r
+run the scripts from their source.\r
+\r
+Windows:\r
+\r
+  The tools written in Python can be executed directly from its source directory\r
 as long as the Python interpreter (Python 2.5) has been installed. Before the execution,\r
 please make sure the environment variable PYTHONPATH is set to \r
 \r