xref: /llvm-project/llvm/docs/GettingStartedTutorials.rst (revision 121bef76df415e4cfc9543630b23f2e648b9a18a)
16d196514SDeForest RichardsGetting Started/Tutorials
26d196514SDeForest Richards=========================
36d196514SDeForest Richards
46d196514SDeForest RichardsFor those new to the LLVM system.
56d196514SDeForest Richards
66d196514SDeForest Richards.. toctree::
76d196514SDeForest Richards   :hidden:
86d196514SDeForest Richards
902d264a5SDeForest Richards   CompilerWriterInfo
10de0e3aacSDeForest Richards   Frontend/PerformanceTips
116d196514SDeForest Richards   GettingStarted
126d196514SDeForest Richards   GettingStartedVS
13de0e3aacSDeForest Richards   ProgrammersManual
146d196514SDeForest Richards   tutorial/index
15*3a6b722dSShivam Gupta   MyFirstTypoFix
166d196514SDeForest Richards
176d196514SDeForest Richards:doc:`GettingStarted`
186d196514SDeForest Richards   Discusses how to get up and running quickly with the LLVM infrastructure.
196d196514SDeForest Richards   Everything from unpacking and compilation of the distribution to execution
206d196514SDeForest Richards   of some tools.
216d196514SDeForest Richards
226d196514SDeForest Richards:doc:`tutorial/index`
236d196514SDeForest Richards   Tutorials about using LLVM. Includes a tutorial about making a custom
246d196514SDeForest Richards   language with LLVM.
256d196514SDeForest Richards
26de0e3aacSDeForest Richards:doc:`ProgrammersManual`
27de0e3aacSDeForest Richards  Introduction to the general layout of the LLVM sourcebase, important classes
28de0e3aacSDeForest Richards  and APIs, and some tips & tricks.
296d196514SDeForest Richards
306d196514SDeForest Richards:doc:`Frontend/PerformanceTips`
316d196514SDeForest Richards   A collection of tips for frontend authors on how to generate IR
326d196514SDeForest Richards   which LLVM is able to effectively optimize.
33de0e3aacSDeForest Richards
34de0e3aacSDeForest Richards:doc:`GettingStartedVS`
35de0e3aacSDeForest Richards   An addendum to the main Getting Started guide for those using Visual Studio
36de0e3aacSDeForest Richards   on Windows.
3702d264a5SDeForest Richards
3802d264a5SDeForest Richards:doc:`CompilerWriterInfo`
3902d264a5SDeForest Richards  A list of helpful links for compiler writers.
40*3a6b722dSShivam Gupta
41*3a6b722dSShivam Gupta:doc:`MyFirstTypoFix`
42*3a6b722dSShivam Gupta   This tutorial will guide you through the process of making a change to
43*3a6b722dSShivam Gupta   LLVM, and contributing it back to the LLVM project.
44