docs/index.rst

   1 Overview
   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 * **Design & Overview**
  17
  18  Several introductory papers and presentations are available at
  19  :doc:`design_and_overview`.
  20
  21 * **Publications**
  22
  23  The list of `publications <http://llvm.org/pubs>`_ based on LLVM.
  24
  25 * **User Guides**
  26
  27  Those new to the LLVM system should first visit the :doc:`userguides`.
  28
  29  NOTE: If you are a user who is only interested in using LLVM-based
  30  compilers, you should look into `Clang <http://clang.llvm.org>`_ or
  31  `DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
  32  intended for users who have a need to work with the intermediate LLVM
  33  representation.
  34
  35 * **API Clients**
  36
  37  Developers of applications which use LLVM as a library should visit the
  38  :doc:`programming`.
  39
  40 * **Subsystems**
  41
  42  API clients and LLVM developers may be interested in the
  43  :doc:`subsystems` documentation.
  44
  45 * **Development Process**
  46
  47  Additional documentation on the LLVM project can be found at
  48  :doc:`development_process`.
  49
  50 * **Mailing Lists**
  51
  52  For more information, consider consulting the LLVM :doc:`mailing_lists`.
  53
  54 .. toctree::
  55    :maxdepth: 2
  56
  57    design_and_overview
  58    userguides
  59    programming
  60    subsystems
  61    development_process
  62    mailing_lists
  63
  64 Indices and tables
  65 ==================
  66
  67 * :ref:`genindex`
  68 * :ref:`search`