Java Tools\r
Apache-ANT, version 1.6.5 or later (http://ant.apache.org)\r
Ant-contrib, version 1.0b2 or later\r
- (http://sourceforge.net/project/showfiles.php?group_id=36177)\r
+ (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)\r
Saxon8, version 8.1.1\r
(http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r
- XMLBeans, version 2.1.0 or later (http://xmlbeans.apache.org) \r
+ XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)\r
+ DO NOT download the latest XMLBeans, version 2.2.0. It cannot work with\r
+ Saxon8, version 8.1.1.\r
\r
Other Tools\r
TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r
\r
\r
-----------------------\r
-Notes On Required Tools (MS Windows environment example)\r
+Notes On Required Tools (With examples for Windows, OS X, and Linux) \r
-----------------------\r
Software Installation Order:\r
After installing the compiler tools and your Subversion client, the following\r
Java Development Kit:\r
\r
The Java Environment Variable must be set before attempting to build.\r
- i.e. For Sun JDK (see note below*):\r
- set JAVA_HOME=c:\ Java\jdk1.5.0_06 \r
- i.e. For Bea Systems:\r
- set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04\r
+ For Sun JDK (see note below*):\r
+ set JAVA_HOME=c:\Java\jdk1.5.0_06 (Windows example)\r
+ export JAVA_HOME=/Library/Java/Home/ (OS X example)\r
+ export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)\r
+ For Bea Systems:\r
+ set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04\r
\r
*When using the Sun JDK5.0\r
During installation, you should specify the install directory as C:\Java\r
The Apache-ANT requires the ANT_HOME environment variable to be set before\r
attempting to build:\r
i.e. set ANT_HOME=c:\<full path to where ant was installed>\r
+ export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)\r
\r
The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
directory.\r
\r
The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
before attempting to build:\r
- i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
+ i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
+ export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)\r
\r
The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
\r
-------------------------------------------------------------------------------\r
Quick Start\r
-----------\r
+For editing text files under Windows, use the Wordpad application. Notepad\r
+does not handle UNIX style newline characters properly.\r
+\r
Copy the target.template file in the Tools/Conf directory to target.txt, which\r
must also be in the Tools/Conf directory.\r
\r
The restictions are used to limit the build output by specifying build target(s), \r
tagname(s) and architecture(s) to less than the full set of possible options. \r
\r
-The ACTIVE_PLATFORM MUST BE SET. All other options need not be set, however by \r
-unsetting these options (by removing the line from the file, or leaving the Value \r
-empty) will result in all available build possibilites when typing build. By\r
-default EDK II can build a matrix of binaries, using different target types, tool\r
-chain tags and architectures. Options to target.txt file are as follows:\r
+The ACTIVE_PLATFORM must be set unless the current working directory contains one\r
+or more FPD files. All other options need not be set, however by unsetting these\r
+options (by removing the line from the file, or leaving the Value empty) will \r
+result in all available build possibilites when typing build. By default EDK II\r
+can build a matrix of binaries, using different target types, tool chain tags and \r
+architectures. Options to target.txt file are as follows:\r
\r
-ACTIVE_PLATFORM = Value REQUIRED\r
+ACTIVE_PLATFORM = Value RECOMMENDED\r
Where Value is the WORKSPACE relative path and filename of a Framework Platform \r
Definition (FPD) File. Example:\r
\r
To test your tool chain setup and to build the Supplied Tools, execute:\r
c:\MyWork\Edk2\> edksetup\r
\r
+On Unix systems you must source the edksetup.sh file to load the correct\r
+settings into your shell.\r
+\r
+ . edksetup.sh # Note the dot.\r
+\r
(This command will be referred to as the setup command throughout the rest of\r
this document.)\r
NOTE: You should run the setup command at the start of every session.\r