Adding image and updated installation instructions
authorlhauch <lhauch@de2fecce-e211-0410-80a6-f3fac2684e05>
Mon, 22 Oct 2007 17:10:33 +0000 (17:10 +0000)
committerlhauch <lhauch@de2fecce-e211-0410-80a6-f3fac2684e05>
Mon, 22 Oct 2007 17:10:33 +0000 (17:10 +0000)
git-svn-id: https://edk2.tianocore.org/svn/edk2/trunk@4198 de2fecce-e211-0410-80a6-f3fac2684e05

www/installation.html
www/top_arrow.jpg [new file with mode: 0644]

index 66e7cc4..d4fdb8d 100644 (file)
@@ -5,8 +5,8 @@
        <TITLE>EDK II Installation Guide</TITLE>\r
        <META NAME="GENERATOR" CONTENT="OpenOffice.org 2.0  (Win32)">\r
        <META NAME="CREATED" CONTENT="20060512;12074440">\r
-       <META NAME="CHANGEDBY" CONTENT="Bruce Bahnsen">\r
-       <META NAME="CHANGED" CONTENT="20060706;14380303">\r
+       <META NAME="CHANGEDBY" CONTENT="Larry Hauch">\r
+       <META NAME="CHANGED" CONTENT="20071022;14380303">\r
        <STYLE>\r
        <!--\r
                H3.heading-2 { font-size: 18pt }\r
        </STYLE>\r
 </HEAD>\r
 <BODY LANG="en-US" DIR="LTR">\r
-<H1>Getting and installing the required tools for building the EDK II</H1>\r
-<H3 CLASS="heading-2">Table of Contents</H3>\r
+<H1>Getting and Installing the Required Tools for Building EDK II</H1>\r
+<H3 CLASS="heading-2">Table of Contents<A NAME="TOP"></A></H3>\r
 <UL>\r
-       <LI><P><A HREF="#Requirements">Requirements</A> \r
-       </P>\r
+       <LI><A HREF="#Requirements">Requirements</A></LI>\r
+       <LI><A HREF="#3rdPartyTools">Third Party Tools</A></LI>\r
+       <LI><A HREF="#Install">Installation & Configuration</A></LI>\r
+       <LI><A HREF="#EnvVars">Environment Variables</A></LI>\r
+       <LI><A HREF="#FirstBuild">First Build</A></LI>\r
 </UL>\r
+\r
+<P><BR></P>\r
 <H3 CLASS="heading-2"><A NAME="Requirements"></A>Requirements</H3>\r
 <DIV ID="requirements" DIR="LTR"><A NAME="requirements_table"></A>\r
   <UL>\r
-    <LI>An IA32 or X64 Based Development Workstation (IPF Workstations are not supported)</LI>\r
-    <LI>Microsoft Windows XP or Vista, Apple Mac OS/X (10.4 or later) or Linux Operating System</LI>\r
-    <LI>Disk Space for compiler tools</LI>\r
-    <LI>Minimum of 1GB of Disk Space for edk2 development tree and output files</LI>\r
+    <LI>An IA32 or X64 based development workstation (IPF workstations are not supported)</LI>\r
+    <LI>Microsoft Windows XP or Vista, Apple Mac OS/X (10.4 or later) or Linux operating system</LI>\r
+    <LI>Disk space for compiler tools</LI>\r
+    <LI>Minimum of 1GB of disk space for edk2 development tree and output files</LI>\r
     <LI>Minimum of 512MB (1GB recommended) of system memory </LI>\r
   </UL>\r
-  <P>The following are required to be able to build the EDK II using the new Makefile build:</P>\r
+  <P>The one of the following is required to be able to obtain the EDK II.</P>\r
        <TABLE BORDER=1 CELLPADDING=1 CELLSPACING=0>\r
                <TR>\r
                        <TH>\r
                                <P ALIGN=CENTER><B>1.4.5</B></P>\r
                        </TD>\r
                        <TD>\r
-                               <P ALIGN=CENTER><A HREF="http://prdownloads.sourceforge.net/tortoisesvn/TortoiseSVN-1.4.5.10425-win32-svn-1.4.5.msi?download">http://prdownloads.sourceforge.net/tortoisesvn/TortoiseSVN-1.4.5.10425-win32-svn-1.4.5.msi</A></P>\r
+                               <P ALIGN=CENTER><A HREF="http://tortoisesvn.net/downloads">http://tortoisesvn.net/downloads</A></P>\r
+                       </TD>\r
+               </TR>\r
+               <TR>\r
+                       <TD>\r
+                               <P ALIGN=CENTER><B>Windows SVN Command Line Tool</B></P>\r
+                       </TD>\r
+                       <TD>\r
+                               <P ALIGN=CENTER><B>1.4.5</B></P>\r
+                       </TD>\r
+                       <TD>\r
+                               <P ALIGN=CENTER><A HREF="http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91">http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91</A></P>\r
+                       </TD>\r
+               </TR>\r
+\r
+               <TR>\r
+                       <TD>\r
+                               <P ALIGN=CENTER><B>Max OS/X SVN Command Line Tool</B></P>\r
+                       </TD>\r
+                       <TD>\r
+                               <P ALIGN=CENTER><B>1.4.4</B></P>\r
+                       </TD>\r
+                       <TD>\r
+                               <P ALIGN=CENTER><A HREF="http://downloads.open.collab.net/binaries.html">http://downloads.open.collab.net/binaries.html</A></P>\r
+                       </TD>\r
+               </TR>\r
+\r
+               <TR>\r
+                       <TD>\r
+                               <P ALIGN=CENTER><B>Linux SVN Command Line Tool</B></P>\r
+                       </TD>\r
+                       <TD>\r
+                               <P ALIGN=CENTER><B>1.4.5</B></P>\r
+                       </TD>\r
+                       <TD>\r
+                               <P ALIGN=CENTER><A HREF="http://subversion.tigris.org/project_packages.html">http://subversion.tigris.org/project_packages.html</A></P>\r
                        </TD>\r
                </TR>\r
 \r
     <!-- Removed ANT/JAVA information -->\r
 \r
        </TABLE>\r
-       <P><BR><BR>\r
-       </P>\r
+  <P><A HREF="#Top"><IMG SRC="top_arrow.jpg" BORDER="0"></A>&nbsp;<A HREF="#Top">Back to Top</A></P>\r
+\r
+       <P><BR></P>\r
+  <H3 CLASS="heading-2"><A NAME="3rdPartyTools"></A>3<sup>rd</sup> Party Tools</H3>\r
        <P>The following tools are optional:<BR>\r
-  <FONT SIZE="1">At least one compiler tool chain will be required</FONT></P>\r
-       <DIV ID="Section1" DIR="LTR"><A NAME="requirements"></A><A NAME="requirements_table1"></A>\r
+  <FONT SIZE="2">At least one 3<sup>rd</sup> party compiler tool chain is required.</FONT></P>\r
+       <DIV ID="Section1" DIR="LTR">\r
                <TABLE BORDER=1 CELLPADDING=1 CELLSPACING=0>\r
                        <TR>\r
                                <TH>\r
                                        </P>\r
                                </TD>\r
                                <TD>\r
-                                       <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
+                                       <P ALIGN=CENTER><A HREF="http://msdn2.microsoft.com/en-us/vstudio/default.aspx">http://msdn2.microsoft.com/en-us/vstudio</A></P>\r
                                </TD>\r
                        </TR>\r
                        <TR>\r
                                        </P>\r
                                </TD>\r
                                <TD>\r
-                                       <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
+                                       <P ALIGN=CENTER><A HREF="http://msdn2.microsoft.com/en-us/vstudio/default.aspx">http://msdn2.microsoft.com/en-us/vstudio</A></P>\r
                                </TD>\r
                        </TR>\r
                        <TR>\r
                                <TD>\r
-                                       <P ALIGN=CENTER><B>Microsoft Visual Studio</B></P>\r
+                                       <P ALIGN=CENTER><B>Microsoft Visual Studio<sup>4</sup></B></P>\r
                                </TD>\r
                                <TD>\r
                                        <P ALIGN=CENTER><B>2003 .NET</B>\r
                                        </P>\r
                                </TD>\r
                                <TD>\r
-                                       <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
+                                       <P ALIGN=CENTER><A HREF="http://msdn2.microsoft.com/en-us/vstudio/default.aspx">http://msdn2.microsoft.com/en-us/vstudio</A></P>\r
                                </TD>\r
                        </TR>\r
                        <TR>\r
                        </TR>\r
                        <TR>\r
                                <TD>\r
-                                       <P ALIGN=CENTER><B>Microsoft Driver Development Kit (DDK)</B><sup>4</sup></P>\r
+                                       <P ALIGN=CENTER><B>Microsoft Driver Development Kit (DDK)</B><sup>5</sup></P>\r
                                </TD>\r
                                <TD>\r
                                        <P ALIGN=CENTER><B>3790.1830</B></P>\r
                                </TD>\r
                        </TR>\r
       <TR>\r
-        <TD ALIGN=LEFT COLSPAN=3>\r
-          <Sup>1</Sup><FONT SIZE="1">&nbsp;Instructions for installation of GCC are included in the BaseTools\Conf directory.</FONT><BR>\r
-          <Sup>2</Sup><FONT SIZE="1">&nbsp;The default tool chain for the IA32 and X64 builds</FONT><BR>\r
-          <Sup>3</Sup><FONT SIZE="1">&nbsp;Needed for building IPF targets if the DDK is not installed.</FONT><BR>\r
-          <Sup>4</Sup><FONT SIZE="1">&nbsp;The default tool chain for IPF builds.</FONT></TD>\r
       </TR>\r
                </TABLE>\r
     <BR>\r
-               <H3 CLASS="heading-2">Install and Configure Tools on Windows XP or Windows Vista</H3>\r
-               <H3>Software Installation Order</H3>\r
+    <P ALIGN=LEFT>\r
+          <FONT SIZE="2"><sup>1</sup>&nbsp;Instructions for installation of GCC are included in the BaseTools\gcc directory.</FONT><BR>\r
+          <FONT SIZE="2"><sup>2</sup>&nbsp;The default tool chain for the IA32 and X64 builds.</FONT><BR>\r
+          <FONT SIZE="2"><sup>3</sup>&nbsp;Needed for building IPF targets if the DDK is not installed.</FONT><BR>\r
+          <FONT SIZE="2"><sup>4</sup>&nbsp;May only be available through a MSDN subscription.</FONT><BR>\r
+          <FONT SIZE="2"><sup>5</sup>&nbsp;The default tool chain for IPF builds.</FONT>\r
+    </P>\r
+    <P><A HREF="#Top"><IMG SRC="top_arrow.jpg" BORDER="0"></A>&nbsp;<A HREF="#Top">Back to Top</A></P>\r
+\r
+         <P><BR></P>\r
+               <H3 CLASS="heading-2"><A NAME="Install"></A>Install and Configure Tools on Windows XP or Windows Vista</H3>\r
+               <H3 CLASS="heading-3">Software Installation Order</H3>\r
                <P>After installing the compiler tools and your Subversion client,\r
                download the edk2, read the BuildNotes2.txt file and you will be\r
-    ready to build and image.</P> \r
+    ready to build an image.</P> \r
     <P>All builds are started from a command prompt window.</P>\r
-    <H3>Cygwin</H3>\r
+    <H3 CLASS="heading-3">Cygwin</H3>\r
                <P>If you optionally install cygwin (for gcc support) you should\r
                install it in &quot;Unix&quot; mode. The gcc tool chain will not\r
                compile in &quot;DOS&quot; mode.</P>\r
-               <H3 CLASS="heading-2">Environment Variables</H3>\r
+\r
+    <P><A HREF="#Top"><IMG SRC="top_arrow.jpg" BORDER="0"></A>&nbsp;<A HREF="#Top">Back to Top</A></P>\r
+               <H3 CLASS="heading-2"><A NAME="EnvVars"></A>Environment Variables</H3>\r
                <P>Environment variables are <B>case sensitive</B>. You must use\r
                the exact case as in the examples of this document. Even though\r
                windows does not care about case, other operating systems that\r
                It is recommended that you wrap up all the environment variables\r
                above into a script that you can launch each time you begin to do\r
                development in your EDK II workspace.</P>\r
-               <H3 CLASS="heading-2">The first build</H3>\r
-               <P>You will need to edit the text file, tools_def.txt, located\r
+\r
+    <P><A HREF="#Top"><IMG SRC="top_arrow.jpg" BORDER="0"></A>&nbsp;<A HREF="#Top">Back to Top</A></P>\r
+               <H3 CLASS="heading-2"><A NAME="FirstBuild"></A>First Build</H3>\r
+               <P>You will need to edit the text file, tools_def.txt which is created\r
+    the first time you run the edksetup script<sup>6</sup>.  The file is located\r
                in the %WORKSPACE%\Conf directory. This file contains the names of the\r
                compiler tool chains and the location of the compiler binaries. It\r
                has been pre-populated with the standard location for the Microsoft\r
                tool chains and includes the standard location of the Intel C\r
                Compiler for EFI Byte Code (EBC).</P>\r
-               <P>Once the external tools are installed, the environment variables\r
-               are set, and you have the ant executable in your path, you can try\r
-               a build.</P>\r
+               <P>Once the external tools are installed and the environment variables\r
+               are set, you can try a build.\r
+    </P>\r
                <OL>\r
                        <LI><P STYLE="margin-bottom: 0in">cd to %WORKSPACE%</P>\r
                        <LI><P STYLE="margin-bottom: 0in">run edksetup.bat --nt32 newbuild\r
       Library and Include locations to build the Nt32 emulation environment.<BR>\r
       <B>Note:</B> If you do not want to build the Nt32 emulation environment, you do not\r
       need to use the --nt32 switch or run vsvars32.bat.</UL></P>\r
-                       <LI><P STYLE="margin-bottom: 0in">cd Nt32Pkg</P>\r
-                       <LI><P STYLE="margin-bottom: 0in">type build \r
-                       </P>\r
-      <P>The default build output directory is: %WORKSPACE%\Build\NT32\DEBUG_MYTOOLS\ \r
-                       </P>\r
+      <LI><P STYLE="margin-bottom: 0in">Modify Conf/tools_def.txt<sup>7</sup></LI></P>\r
+                       <LI><P STYLE="margin-bottom: 0in">cd Nt32Pkg </P>\r
+                       <LI><P STYLE="margin-bottom: 0in">type build </P>\r
+      <P>The default build output directory is: %WORKSPACE%\Build\NT32\DEBUG_MYTOOLS\ </P>\r
                </OL>\r
        </DIV>\r
+  <P><FONT SIZE="2"><sup>6</sup>&nbsp;The first time the edksetup script is executed, it\r
+  creates three files in the %WORKSPACE%\Conf directory.  The tools_def.txt, target.txt and\r
+  build_rule.txt files are only created if they do not exist, if they exist, then they are \r
+  not touched.</FONT><BR>\r
+  <FONT SIZE="2"><sup>7</sup>&nbsp;The tools_def.txt file only needs to be modified the\r
+  first time, or if you modify the location of the 3<sup>rd</sup> party tool chains after\r
+  having setup the file.</FONT></P>\r
+  <P><A HREF="#Top"><IMG SRC="top_arrow.jpg" BORDER="0"></A>&nbsp;<A HREF="#Top">Back to Top</A></P>\r
 </DIV>\r
 </BODY>\r
 </HTML>\r
diff --git a/www/top_arrow.jpg b/www/top_arrow.jpg
new file mode 100644 (file)
index 0000000..c235a8c
Binary files /dev/null and b/www/top_arrow.jpg differ