Clarify the instructions.
authorbbahnsen <bbahnsen@de2fecce-e211-0410-80a6-f3fac2684e05>
Thu, 4 May 2006 20:25:03 +0000 (20:25 +0000)
committerbbahnsen <bbahnsen@de2fecce-e211-0410-80a6-f3fac2684e05>
Thu, 4 May 2006 20:25:03 +0000 (20:25 +0000)
git-svn-id: https://edk2.tianocore.org/svn/edk2/trunk@102 de2fecce-e211-0410-80a6-f3fac2684e05

www/index.html
www/installation.html

index 346c28a..bae457c 100644 (file)
@@ -16,7 +16,8 @@ Tracker</a> tool. </p>
 <p> To get the code please follow this <a
  href="https://edk2.tianocore.org/files/documents/64/239/edk2-subversion-setup.pdf">document</a>.
 It will walk you through the installation of the Subversion Software
-Configuration Management Client, TortoiseSVN, and show you how to pull
+Configuration Management Client, <span style="font-weight: bold;">TortoiseSVN</span>,
+and show you how to pull
 the latest copy of the tree. </p>
 <p><a href="https://edk2.tianocore.org/installation.html"><span
  style="font-weight: bold;">I</span><span style="font-weight: bold;">nstall
@@ -25,12 +26,18 @@ external tools</span></a> that are necessary to build the code. </p>
 <p> Further instructions for using the EDK2.0 are provided in the <b>ReleaseNotes.txt</b>
 at the top of the edk2 tree. You may also view the Release Notes using
 the <a
- href="https://edk2.tianocore.org/source/browse/edk2/trunk/edk2/ReleaseNotes.txt">
+ href="https://edk2.tianocore.org/source/browse/edk2/trunk/edk2/ReleaseNotes.txt?rev=HEAD&amp;view=markup">
 web interface to the Subversion repository</a>. </p>
-<p> If you have questions about the code, please post a note on the <a
- href="mailto:dev@edk2.tianocore.org">dev@edk2.tianocore.org</a>
+<p><span style="font-weight: bold;">Help!</span> If you have questions
+about the code or run into obstacles getting things to work for you,
+please post a note on the <a href="mailto:dev@edk2.tianocore.org">dev@edk2.tianocore.org</a>
 mailing list. One of our friendly developers will be happy to help you.
-You may subscribe to the mail lists of the edk2 project <a
+<br>
+</p>
+<p>You are <span style="font-weight: bold;">not </span>signed up to
+the project mailing lists by default. I encourage you to <span
+ style="font-weight: bold;">subscribe </span>to the mail lists of the
+edk2 project <a
  href="https://edk2.tianocore.org/servlets/ProjectMailingListList">here</a>.<br>
 </p>
 <p><br>
index 0e0db6a..e145cd1 100644 (file)
@@ -6,7 +6,9 @@
   <title>EDK 2.0 Installation Guide</title>\r
 </head>\r
 <body>\r
-<h2>Table of Contents</h2>\r
+<h3>Gett<br>\r
+</h3>\r
+<h3>Table of Contents</h3>\r
 <ul>\r
   <li><a href="#Requirements">Requirements</a></li>\r
 </ul>\r
@@ -166,7 +168,7 @@ ACPI Component Architecture<br>
     </tr>\r
   </tbody>\r
 </table>\r
-<h3>Install and <span style="font-weight: bold;"></span>Configure\r
+<h3>Install and Configure\r
 Tools on Windows XP<br>\r
 </h3>\r
 <h4>Software Installation Order</h4>\r
@@ -174,10 +176,9 @@ After installing the compiler tools and your Subversion client, the
 following required tools should be installed in this order: <br>\r
 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8<br>\r
 <h4>Java Development Kit</h4>\r
-The JAVA_HOME Environment Variable must be set before attempting to\r
-build.<br>\r
+The Java Environment Variable must be set before attempting to build.<br>\r
 e.g. For Sun JDK:<br>\r
-<pre><span style="font-weight: bold;">set JAVA_HOME=c:\Java\jdk1.5.0_06</span><br></pre>\r
+<pre>set JAVA_HOME=c:\Java\jdk1.5.0_06</pre>\r
 During installation, you should specify the install directory as\r
 C:\Java instead of C:\Program Files (or some other drive letter.)&nbsp;\r
 While installing to this non-standard location is not required. In use,\r
@@ -190,21 +191,41 @@ JDK install.<br>
 The Apache-ANT requires the ANT_HOME environment variable to be set\r
 before attempting to build:<br>\r
 <pre>set ANT_HOME=c:\&lt;full path to where ant was installed&gt;</pre>\r
-The ant-contrib.jar file should be installed in the %ANT_HOME%\lib\r
+The ant-contrib.jar file should be <span style="font-weight: bold;">installed</span>\r
+in the %ANT_HOME%\lib\r
 directory.<br>\r
 <br>\r
 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
 before attempting to build:<br>\r
-<pre>set XMLBEANS_HOME=C:\&lt;full path to where xmlbeans&nbsp; was installed&gt;</pre>\r
-The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib\r
+<pre>set XMLBEANS_HOME=C:\&lt;full path to where xmlbeans was installed&gt;</pre>\r
+The saxon8.jar file should be <span style="font-weight: bold;">copied </span>to\r
+the %XMLBEANS_HOME%\lib\r
 directory.<br>\r
 <br>\r
 The Ant and XMLBean tools are required to be in the path.<br>\r
 <pre>set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin<br></pre>\r
-<h4>Environment Variables</h4>\r
+<h3>Cygwin</h3>\r
+If you optionally install cygwin (for gcc support) you should install\r
+it in "Unix" mode. The gcc tool chain will not compile in "DOS" mode.<br>\r
+<h3>Environment Variables</h3>\r
+You need to set WORKSPACE to the location of the edk2 directory that\r
+you pulled from Subversion. For example<br>\r
+<pre>set WORKSPACE=c:\workspace\edk2\</pre>\r
 It is recommended that you wrap up all the environment variables above\r
 into a script that you can launch each time you begin to do development\r
 in your EDK2 workspace.<br>\r
+<h3>The first build</h3>\r
+Once the external tools are installed, the environment variables are\r
+set, and you have the ant executable in your path, you can try a build.<br>\r
+<ol>\r
+  <li>cd to %WORKSPACE%</li>\r
+  <li>run edksetup.bat (this will build several tools that are used in\r
+edk2 development. It will fail if the external tools above are not\r
+properly installed.)<br>\r
+  </li>\r
+  <li>cd MdePkg</li>\r
+  <li>type ant</li>\r
+</ol>\r
 </div>\r
 </div>\r
 </body>\r