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    GettingStartedTutorials
  57    Reference
  58    UserGuides
  59
  60 :doc:`GettingStartedTutorials`
  61   For those new to the LLVM system.
  62
  63 :doc:`UserGuides`
  64   User guides and How-tos.
  65
  66 :doc:`Reference`
  67   LLVM and API reference documentation.
  68
  69 Community
  70 =========
  71
  72 LLVM welcomes contributions of all kinds. To learn more, see the following articles:
  73
  74 .. toctree::
  75    :hidden:
  76
  77    GettingInvolved
  78
  79 * :doc:`GettingInvolved`
  80 * :ref:`development-process`
  81 * :ref:`mailing-lists`
  82 * :ref:`meetups-social-events`
  83 * :ref:`community-proposals`
  84
  85 Indices and tables
  86 ==================
  87
  88 * :ref:`genindex`
  89 * :ref:`search`