Add more instructions for OS X and Linux.
[mirror_edk2.git] / ReleaseNotes.txt
index ea82d5a..418398f 100644 (file)
@@ -113,7 +113,7 @@ The URL of the document repository is:
 \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
@@ -123,9 +123,11 @@ Software Installation Order:
 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
+       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
@@ -145,6 +147,7 @@ Java Tools:
     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
@@ -152,6 +155,7 @@ Java Tools:
     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
+          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
@@ -278,6 +282,11 @@ In a command window, change to the top level directory of the Edk II sources.
 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