summaryrefslogtreecommitdiff
path: root/docs/GettingStarted.html
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2004-12-08 16:18:26 +0000
committerReid Spencer <rspencer@reidspencer.com>2004-12-08 16:18:26 +0000
commitc4b09ba2884c5df683c30cedf1736c92700ac3e5 (patch)
tree6bf2108af2258bb1ae4e58854b89d7faf81621a3 /docs/GettingStarted.html
parent6d8dbecff2d2c7aeb509db12e3029b1f3882a280 (diff)
downloadllvm-c4b09ba2884c5df683c30cedf1736c92700ac3e5.tar.gz
llvm-c4b09ba2884c5df683c30cedf1736c92700ac3e5.tar.bz2
llvm-c4b09ba2884c5df683c30cedf1736c92700ac3e5.tar.xz
Add descriptions of missing top level directories.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@18629 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/GettingStarted.html')
-rw-r--r--docs/GettingStarted.html32
1 files changed, 28 insertions, 4 deletions
diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html
index 4e8702769b..31b47ad940 100644
--- a/docs/GettingStarted.html
+++ b/docs/GettingStarted.html
@@ -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 @@ The following is a brief introduction to code layout:</p>
<!-- ======================================================================= -->
<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 @@ library. The three main subdirectories of this directory are:</p>
<!-- ======================================================================= -->
<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 @@ different <a href="#tools">tools</a>.</p>
</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 @@ are code generators for parts of LLVM infrastructure.</p>
</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>