1About
2========
3
4.. warning::
5
6   If you are using a released version of LLVM, see `the download page
7   <https://llvm.org/releases/>`_ to find your documentation.
8
9The LLVM compiler infrastructure supports a wide range of projects, from
10industrial strength compilers to specialized JIT applications to small
11research projects.
12
13Similarly, documentation is broken down into several high-level groupings
14targeted at different audiences:
15
16LLVM Design & Overview
17======================
18
19Several 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  .. __: https://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
31
32`Intro to LLVM`__
33  A chapter from the book "The Architecture of Open Source Applications" that
34  describes high-level design decisions that shaped LLVM.
35
36  .. __: http://www.aosabook.org/en/llvm.html
37
38
39`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
40  Design overview.
41
42  .. __: https://llvm.org/pubs/2004-01-30-CGO-LLVM.html
43
44`LLVM: An Infrastructure for Multi-Stage Optimization`__
45  More details (quite old now).
46
47  .. __: https://llvm.org/pubs/2002-12-LattnerMSThesis.html
48
49Documentation
50=============
51
52Getting Started, How-tos, Developer Guides, and Tutorials.
53
54.. toctree::
55   :hidden:
56
57   GettingStartedTutorials
58   Reference
59   UserGuides
60   DiscourseMigrationGuide
61
62:doc:`GettingStartedTutorials`
63  For those new to the LLVM system.
64
65:doc:`UserGuides`
66  User guides and How-tos.
67
68:doc:`Reference`
69  LLVM and API reference documentation.
70
71:doc:`DiscourseMigrationGuide`
72  Guide for users to migrate to Discourse
73
74Community
75=========
76
77LLVM welcomes contributions of all kinds. To learn more, see the following articles:
78
79.. toctree::
80   :hidden:
81
82   GettingInvolved
83
84* :doc:`GettingInvolved`
85* :ref:`development-process`
86* :ref:`lists-forums`
87* :ref:`meetups-social-events`
88* :ref:`community-proposals`
89
90  Reporting a security issue
91
92* :ref:`report-security-issue`
93
94Indices and tables
95==================
96
97* :ref:`genindex`
98* :ref:`search`
99