Home | History | Annotate | Download | only in docs
      1 .. _contents:
      2 
      3 Overview
      4 ========
      5 
      6 .. warning::
      7 
      8    If you are using a released version of LLVM, see `the download page
      9    <http://llvm.org/releases/>`_ to find your documentation.
     10 
     11 The LLVM compiler infrastructure supports a wide range of projects, from
     12 industrial strength compilers to specialized JIT applications to small
     13 research projects.
     14 
     15 Similarly, documentation is broken down into several high-level groupings
     16 targeted at different audiences:
     17 
     18   * **Design & Overview**
     19 
     20     Several introductory papers and presentations are available at
     21     :ref:`design_and_overview`.
     22 
     23   * **Publications**
     24 
     25     The list of `publications <http://llvm.org/pubs>`_ based on LLVM.
     26 
     27   * **User Guides**
     28 
     29     Those new to the LLVM system should first vist the :ref:`userguides`.
     30 
     31     NOTE: If you are a user who is only interested in using LLVM-based
     32     compilers, you should look into `Clang <http://clang.llvm.org>`_ or
     33     `DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
     34     intended for users who have a need to work with the intermediate LLVM
     35     representation.
     36 
     37   * **API Clients**
     38 
     39     Developers of applications which use LLVM as a library should visit the
     40     :ref:`programming`.
     41 
     42   * **Subsystems**
     43 
     44     API clients and LLVM developers may be interested in the
     45     :ref:`subsystems` documentation.
     46 
     47   * **Development Process**
     48 
     49     Additional documentation on the LLVM project can be found at
     50     :ref:`development_process`.
     51 
     52   * **Mailing Lists**
     53 
     54     For more information, consider consulting the LLVM :ref:`mailing_lists`.
     55 
     56 .. toctree::
     57    :maxdepth: 2
     58 
     59    design_and_overview
     60    userguides
     61    programming
     62    subsystems
     63    development_process
     64    mailing_lists
     65    
     66 Indices and tables
     67 ==================
     68 
     69 * :ref:`genindex`
     70 * :ref:`search`
     71