note where to get steens-aa and ds-aa
[oota-llvm.git] / docs / GettingStartedVS.html
index 87be6cfcc837f8f6c766b27af8a3692afff64235..9526af57b47f048c82cf5008332e63d00e057dc8 100644 (file)
@@ -99,7 +99,7 @@
       <li><tt>cd llvm</tt></li>
     </ol></li>
 
-    <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
+    <li>With anonymous CVS access:
     <ol>
       <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
       <li><tt>cvs -d
@@ -170,15 +170,10 @@ progress has been made since the 1.4 release.</p>
   beta, there are no guarantees and there is no support for it at this time.
   It has been reported that VC++ Express also works.</p>
 
-  <p>You will also need several open source packages:  bison, flex, and sed.
-  These must be installed in <tt>llvm/win32/tools</tt>.  These can be found at
-  <a href="http://gnuwin32.sourceforge.net">http://gnuwin32.sourceforge.net</a>
-  or
-  <a href="http://unxutils.sourceforge.net">http://unxutils.sourceforge.net</a>.
-  Bison prefers that m4 be in the path.  You must add it to the Visual Studio
-  configuration under the menu Options -&gt; Projects -&gt; VC++ Directories.
-  Alternatively, you can set the environment variable <tt>M4</tt> to point to
-  <tt>m4</tt> executable.</p>
+  <p>If you plan to modify any .y or .l files, you will need to have bison
+  and/or flex installed where Visual Studio can find them.  Otherwise, you do
+  not need them and the pre-generated files that come with the source tree
+  will be used.</p>
 
 </div>
 
@@ -263,44 +258,46 @@ All these paths are absolute:</p>
        </pre></li>
 
   <li><p>Next, compile the C file into a LLVM bytecode file:</p>
-      <p><tt>% llvm-gcc hello.c -o hello</tt></p>
-
-      <p>Note that you should have already built the tools and they have to be
-      in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
-
-      <p>This will create two result files: <tt>hello</tt> and
-      <tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that
-      corresponds the the compiled program and the library facilities that it
-      required.  <tt>hello</tt> is a simple shell script that runs the bytecode
-      file with <tt>lli</tt>, making the result directly executable.  Note that
-      all LLVM optimizations are enabled by default, so there is no need for a 
-      "-O3" switch.</p>
+      <p><tt>% llvm-gcc -c hello.c -emit-llvm -o hello.bc</tt></p>
+
+      <p>This will create the result file <tt>hello.bc</tt> which is the LLVM 
+      bytecode that corresponds the the compiled program and the library 
+      facilities that it required.  You can execute this file directly using
+      <tt>lli</tt> tool, compile it to native assembly with the <tt>llc</tt>, 
+      optimize or analyze it further with the <tt>opt</tt> tool, etc.</p> 
       
       <p><b>Note: while you cannot do this step on Windows, you can do it on a
-        Unix system and transfer <tt>hello.bc</tt> to Windows.</b></p></li>
+        Unix system and transfer <tt>hello.bc</tt> to Windows.  Important:
+        transfer as a binary file!</b></p></li>
 
-  <li><p>Run the program. To make sure the program ran, execute the
-      following command:</p>
+  <li><p>Run the program using the just-in-time compiler:</p>
       
       <p><tt>% lli hello.bc</tt></p></li>
 
+      <p>Note: this will only work for trivial C programs.  Non-trivial programs
+        (and any C++ program) will have dependencies on the GCC runtime that
+        won't be satisfied by the Microsoft runtime libraries.</p>
+
   <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
       code:</p>
 
-      <p><tt>% llvm-dis &lt; hello.bc | less</tt><p></li>
+      <p><tt>% llvm-dis &lt; hello.bc | more</tt><p></li>
+
+  <li><p>Compile the program to C using the LLC code generator:</p>
 
-  <li><p>Compile the program to native assembly using the LLC code
-      generator:</p>
+      <p><tt>% llc -march=c hello.bc</tt></p></li>
 
-      <p><tt>% llc hello.bc -o hello.s</tt></p>
+  <li><p>Compile to binary using Microsoft C:</p>
 
-  <li><p>Assemble the native assembly language file into a program:</p>
+      <p><tt>% cl hello.cbe.c</tt></p></li>
 
-  <p><b>Not currently possible, but eventually will use <tt>NASMW</tt>.</b></p>
+      <p>Note: this will only work for trivial C programs.  Non-trivial programs
+        (and any C++ program) will have dependencies on the GCC runtime that
+        won't be satisfied by the Microsoft runtime libraries.</p>
 
   <li><p>Execute the native code program:</p>
 
-      <p><tt>% ./hello.native</tt></p></li>
+      <p><tt>% hello.cbe.exe</tt></p></li>
 
 </ol>
 
@@ -335,9 +332,9 @@ if you want to write something up!).  For more information about LLVM, check
 out:</p>
 
 <ul>
-  <li><a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a></li>
-  <li><a href="http://llvm.cs.uiuc.edu/doxygen/">LLVM doxygen tree</a></li>
-  <li><a href="http://llvm.cs.uiuc.edu/docs/Projects.html">Starting a Project
+  <li><a href="http://llvm.org/">LLVM homepage</a></li>
+  <li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
+  <li><a href="http://llvm.org/docs/Projects.html">Starting a Project
   that Uses LLVM</a></li>
 </ul>
 
@@ -353,7 +350,7 @@ out:</p>
   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 
   <a href="mailto:jeffc@jolt-lang.org">Jeff Cohen</a><br>
-  <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
+  <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
   Last modified: $Date$
 </address>
 </body>