Use ASM_PFX to optionnaly set the underscore prefix
[mirror_edk2.git] / BuildNotes.txt
index 00c2e42..1d85937 100644 (file)
@@ -13,7 +13,7 @@ how to install and build the EDK II.
 \r
 Package Contents\r
 ----------------\r
-  ReleaseNote.txt- These release notes for the package.\r
+  BuildNotes.txt - The build notes for this package.\r
   MdePkg         - Industry-standard headers and libraries\r
   Tools          - Build -specific tools that are designed to help the \r
                    developer create and modify drivers and libraries\r
@@ -95,6 +95,25 @@ Compiler Tool Chains:
     Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
     Intel ACPI Component Architecture, version 20060113\r
 \r
+Python\r
+\r
+    There are several tools implemented in Python and wxPython Widgets in the\r
+    Tools/Python directory. These are optional tools, and are not necessary in\r
+    order to use or build the edk2 code.  In order to use them you must\r
+    install Python 2.4.x and wxWidgets 2.8.x for your platform.  The tools\r
+    have been tested and work correctly on OS X, Linux and Windows.\r
+\r
+    There is a script called Install_Python_OSX.sh that will download and\r
+    install the correct versions for OS X. For other platforms, please find\r
+    the installers for your platform at the following sites:\r
+\r
+    - http://www.python.org/download/releases/2.4.4/ (Python interpreter)\r
+    - http://www.wxpython.org/download.php#binaries  (Python GUI extensions)\r
+\r
+    Your linux distribution may contain packages of python and wxPython, which\r
+    should work, provided they are are compatible with the above specified\r
+    versions.\r
+\r
 -----------------------------------------------\r
 Notes on Required Tools (Source Control System)\r
 -----------------------------------------------\r
@@ -354,7 +373,7 @@ This command builds the active platform specified in text file target.txt. If
 the active platform is not specified target.txt, you must execute the build \r
 command from the sub-directory that contains FPD files. For more information \r
 about the active platform policy, see the \93EDK II Build and Packaging \r
-Architecture Specification.?
+Architecture Specification.?\r
 \r
 -------------------------------------------------------------------------------\r
 Detailed Starting Instructions\r
@@ -415,7 +434,7 @@ This command builds the active platform specified in text file target.txt. If
 the active platform is not specified, go to the sub-directory that contains FPD \r
 files and execute the build command. For more information about the active \r
 platform policy, see the \93EDK II Build and Packaging Architecture \r
-Specification.?
+Specification.?\r
 \r
 --------------------------\r
 Individual Platform Builds\r
@@ -480,7 +499,7 @@ the modules that the package contains, including the location of all MSA files,
 and public library names and headers that might be provided by a module in the\r
 package.  Packages are defined by SPD files.  (Found in the root of the Package\r
 subdirectory (i.e. EdkNt32Pkg).) The SPD file is further explained in \93EDK II \r
-Build and Packaging Architecture Specification.?
+Build and Packaging Architecture Specification.?\r
  \r
 B) Module Surface Area Definition (MSA) files.  A description of a module's \r
 surface area, with all module specific default flags and features specified.\r
@@ -667,3 +686,5 @@ Of particular note:
 =======================================================\r
 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4890, no\r
 virus detected.\r
+\r
+vim:tw=78:ts=2:fo=qa:com=fb\:- :ai\r