From 62b0ecbdfe31cde400a4aee77f90b7373a957a01 Mon Sep 17 00:00:00 2001 From: Reid Spencer Date: Wed, 8 Dec 2004 16:18:26 +0000 Subject: [PATCH] Add descriptions of missing top level directories. llvm-svn: 18629 --- docs/GettingStarted.html | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index 4e8702769b8..31b47ad9401 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -38,13 +38,16 @@
  • Program layout
    1. CVS directories +
    2. llvm/examples
    3. llvm/include
    4. llvm/lib +
    5. llvm/projects
    6. llvm/runtime
    7. llvm/test
    8. llvm-test
    9. llvm/tools
    10. llvm/utils +
    11. llvm/win32
  • An Example Using the LLVM Tool Chain @@ -1015,17 +1018,20 @@ The following is a brief introduction to code layout:

    CVS directories
    -
    -

    Every directory checked out of CVS will contain a CVS directory; for the most part these can just be ignored.

    +
    + +
    llvm/examples
    +
    +

    This directory contains some simple examples of how to use the LLVM IR and + JIT.

    llvm/include
    -

    This directory contains public header files exported from the LLVM @@ -1054,7 +1060,6 @@ library. The three main subdirectories of this directory are:

    llvm/lib
    -

    This directory contains most of the source files of the LLVM system. In LLVM, @@ -1114,6 +1119,16 @@ different tools.

    + +
    llvm/projects
    +
    +

    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 llvm/projects/sample for an example of how + to set up your own project. See llvm/projects/Stacker for a fully + functional example of a compiler front end.

    +
    +
    llvm/runtime
    @@ -1331,6 +1346,15 @@ are code generators for parts of LLVM infrastructure.

    + +
    llvm/win32
    +
    +

    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. +

    +
    An Example Using the LLVM Tool Chain