1.. _userguides:
2
3User Guides
4===========
5
6.. toctree::
7   :hidden:
8
9   CMake
10   HowToBuildOnARM
11   CommandGuide/index
12   DeveloperPolicy
13   GettingStartedVS
14   FAQ
15   Lexicon
16   Packaging
17   HowToAddABuilder
18   yaml2obj
19   HowToSubmitABug
20
21* `The LLVM Getting Started Guide <GettingStarted.html>`_
22    
23   Discusses how to get up and running quickly with the LLVM infrastructure.
24   Everything from unpacking and compilation of the distribution to execution
25   of some tools.
26    
27* :ref:`building-with-cmake`
28
29   An addendum to the main Getting Started guide for those using the `CMake
30   build system <http://www.cmake.org>`_.
31
32* :ref:`how_to_build_on_arm`
33
34   Notes on building and testing LLVM/Clang on ARM.
35
36* `Getting Started with the LLVM System using Microsoft Visual Studio
37  <GettingStartedVS.html>`_
38
39   An addendum to the main Getting Started guide for those using Visual Studio
40   on Windows.
41    
42* `LLVM Tutorial <tutorial/>`_
43
44   A walk through the process of using LLVM for a custom language, and the
45   facilities LLVM offers in tutorial form.
46
47* :ref:`developer_policy`
48
49   The LLVM project's policy towards developers and their contributions.
50
51* :ref:`LLVM Command Guide <commands>`
52
53   A reference manual for the LLVM command line utilities ("man" pages for LLVM
54   tools).
55    
56* `LLVM's Analysis and Transform Passes <Passes.html>`_
57
58   A list of optimizations and analyses implemented in LLVM.
59    
60* :ref:`faq`
61
62   A list of common questions and problems and their solutions.
63    
64* `Release notes for the current release <ReleaseNotes.html>`_
65
66   This describes new features, known bugs, and other limitations.
67
68* :ref:`how-to-submit-a-bug-report`
69    
70   Instructions for properly submitting information about any bugs you run into
71   in the LLVM system.
72    
73* `LLVM Testing Infrastructure Guide <TestingGuide.html>`_
74
75   A reference manual for using the LLVM testing infrastructure.
76    
77* `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_
78
79   Instructions for building the clang front-end from source.
80    
81* :ref:`packaging`
82
83   Advice on packaging LLVM into a distribution.
84    
85* :ref:`lexicon`
86
87   Definition of acronyms, terms and concepts used in LLVM.
88
89* :ref:`how_to_add_a_builder`
90
91   Instructions for adding new builder to LLVM buildbot master.
92    
93* **IRC** -- You can probably find help on the unofficial LLVM IRC.
94
95   We often are on irc.oftc.net in the #llvm channel.  If you are using the
96   mozilla browser, and have chatzilla installed, you can `join #llvm on
97   irc.oftc.net <irc://irc.oftc.net/llvm>`_.
98