docs/index.rst

   1 About
   2 ========
   3
   4 .. warning::
   5
   6    If you are using a released version of LLVM, see `the download page
   7    <http://llvm.org/releases/>`_ to find your documentation.
   8
   9 The LLVM compiler infrastructure supports a wide range of projects, from
  10 industrial strength compilers to specialized JIT applications to small
  11 research projects.
  12
  13 Similarly, documentation is broken down into several high-level groupings
  14 targeted at different audiences:
  15
  16 LLVM Design & Overview
  17 ======================
  18
  19 Several introductory papers and presentations.
  20
  21 .. toctree::
  22    :hidden:
  23
  24    FAQ
  25    Lexicon
  26
  27 `Introduction to the LLVM Compiler`__
  28   Presentation providing a users introduction to LLVM.
  29
  30   .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
  31
  32 `Intro to LLVM`__
  33   Book chapter providing a compiler hacker's introduction to LLVM.
  34
  35   .. __: http://www.aosabook.org/en/llvm.html
  36
  37
  38 `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
  39   Design overview.
  40
  41   .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
  42
  43 `LLVM: An Infrastructure for Multi-Stage Optimization`__
  44   More details (quite old now).
  45
  46   .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
  47
  48 Documentation
  49 =============
  50
  51 Getting Started, How-tos, Developer Guides, and Tutorials.
  52
  53 .. toctree::
  54    :hidden:
  55
  56    UserGuides
  57    ProgrammingDocumentation
  58    Reference
  59    SubsystemDocumentation
  60
  61 :doc:`UserGuides`
  62   For those new to the LLVM system.
  63
  64 :doc:`ProgrammingDocumentation`
  65   For developers of applications which use LLVM as a library.
  66
  67 :doc:`SubsystemDocumentation`
  68   For API clients and LLVM developers.
  69
  70 :doc:`Reference`
  71   LLVM and API reference documentation.
  72
  73 Getting Started/Tutorials
  74 -------------------------
  75
  76 .. toctree::
  77    :hidden:
  78
  79    GettingStarted
  80    tutorial/index
  81    GettingStartedVS
  82
  83 :doc:`GettingStarted`
  84    Discusses how to get up and running quickly with the LLVM infrastructure.
  85    Everything from unpacking and compilation of the distribution to execution
  86    of some tools.
  87
  88 :doc:`tutorial/index`
  89    Tutorials about using LLVM. Includes a tutorial about making a custom
  90    language with LLVM.
  91
  92 :doc:`GettingStartedVS`
  93    An addendum to the main Getting Started guide for those using Visual Studio
  94    on Windows.
  95
  96 Community
  97 =========
  98
  99 LLVM welcomes contributions of all kinds. To learn more, see the following articles:
 100
 101 .. toctree::
 102    :hidden:
 103
 104    GettingInvolved
 105
 106 * :doc:`GettingInvolved`
 107 * :ref:`development-process`
 108 * :ref:`mailing-lists`
 109 * :ref:`meetups-social-events`
 110 * :ref:`community-proposals`
 111
 112 Indices and tables
 113 ==================
 114
 115 * :ref:`genindex`
 116 * :ref:`search`