[llvm-commits] CVS: llvm/docs/GettingStarted.html

Reid Spencer reid at x10sys.com
Wed Dec 8 08:18:40 PST 2004



Changes in directory llvm/docs:

GettingStarted.html updated: 1.82 -> 1.83
---
Log message:

Add descriptions of missing top level directories.


---
Diffs of the changes:  (+29 -5)

Index: llvm/docs/GettingStarted.html
diff -u llvm/docs/GettingStarted.html:1.82 llvm/docs/GettingStarted.html:1.83
--- llvm/docs/GettingStarted.html:1.82	Sun Dec  5 11:48:03 2004
+++ llvm/docs/GettingStarted.html	Wed Dec  8 10:18:26 2004
@@ -38,13 +38,16 @@
   <li><a href="#layout">Program layout</a>
     <ol>
       <li><a href="#cvsdir"><tt>CVS</tt> directories</a>
+      <li><a href="#examples"><tt>llvm/examples</tt></a>
       <li><a href="#include"><tt>llvm/include</tt></a>
       <li><a href="#lib"><tt>llvm/lib</tt></a>
+      <li><a href="#projects"><tt>llvm/projects</tt></a>
       <li><a href="#runtime"><tt>llvm/runtime</tt></a>  
       <li><a href="#test"><tt>llvm/test</tt></a>
       <li><a href="#llvmtest"><tt>llvm-test</tt></a>
       <li><a href="#tools"><tt>llvm/tools</tt></a>  
       <li><a href="#utils"><tt>llvm/utils</tt></a>
+      <li><a href="#win32"><tt>llvm/win32</tt></a>
     </ol></li>
 
   <li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
@@ -1015,17 +1018,20 @@
 
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="cvsdir"><tt>CVS</tt> directories</a></div>
-
 <div class="doc_text">
-
 <p>Every directory checked out of CVS will contain a <tt>CVS</tt> directory; for
 the most part these can just be ignored.</p>
+</div>
 
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div>
+<div class="doc_text">
+  <p>This directory contains some simple examples of how to use the LLVM IR and
+  JIT.</p>
 </div>
 
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div>
-
 <div class="doc_text">
 
 <p>This directory contains public header files exported from the LLVM
@@ -1054,7 +1060,6 @@
 
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div>
-
 <div class="doc_text">
 
 <p>This directory contains most of the source files of the LLVM system. In LLVM,
@@ -1115,6 +1120,16 @@
 </div>
 
 <!-- ======================================================================= -->
+<div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div>
+<div class="doc_text">
+  <p>This directory contains projects that are not strictly part of LLVM but are
+  shipped with LLVM. This is also the directory where you should create your own
+  LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
+  to set up your own project. See <tt>llvm/projects/Stacker</tt> for a fully 
+  functional example of a compiler front end.</p>
+</div>
+
+<!-- ======================================================================= -->
 <div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div>
 <div class="doc_text">
 
@@ -1331,6 +1346,15 @@
 
 </div>
 
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="win32"><tt>llvm/win32</tt></a></div>
+<div class="doc_text">
+  <p>This directory contains build scripts and project files for use with 
+  Visual C++. This allows developers on Windows to build LLVM without the need
+  for cygwin. The contents of this directory should be considered experimental
+  at this time.
+  </p>
+</div>
 <!-- *********************************************************************** -->
 <div class="doc_section">
   <a name="tutorial">An Example Using the LLVM Tool Chain</a>
@@ -1444,7 +1468,7 @@
   <a href="mailto:sabre at nondot.org">Chris Lattner</a><br>
   <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
-  Last modified: $Date: 2004/12/05 17:48:03 $
+  Last modified: $Date: 2004/12/08 16:18:26 $
 </address>
 </body>
 </html>






More information about the llvm-commits mailing list