1 The LLVM Compiler Infrastructure
2 http://llvm.cs.uiuc.edu
6 This file is intended to do four things:
7 (1) help you get started using LLVM;
8 (2) tell you how to get questions about LLVM answered;
9 (3) tell you where to find documentation for different kinds of questions; and
10 (4) tell you about three LLVM-related mailing lists.
13 Getting Started with LLVM
14 -------------------------
16 (1) For license information:
19 (2) Installing and compiling LLVM:
20 llvm/docs/GettingStarted.html
22 (3) Learn about features and limitations of this release:
23 llvm/docs/ReleaseNotes.html
25 (4) Learn how to write a pass within the LLVM system:
26 llvm/docs/WritingAnLLVMPass.html
28 (5) Learn how to start a new development project using LLVM, where your
29 new source code can live anywhere (outside or inside the LLVM tree),
30 while using LLVM header files and libraries:
31 llvm/docs/Projects.html
34 Getting Help with LLVM
35 ----------------------
37 (1) If you have questions or development problems not answered in the
38 documentation, send e-mail to llvmdev@cs.uiuc.edu. This mailing list is
39 monitored by all the people in the LLVM group at Illinois, and you should
40 expect prompt first responses.
42 (2) To report a bug, submit a bug report as described in the document:
43 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
45 (3) We now use Bugzilla to track bugs, so you can check the status of
47 <FIXME: WHERE DO THEY GO???>
53 All the documents mentioned below except the design overview tech report
54 are include as part of the LLVM release (in llvm/docs/*):
57 LLVM : A Compilation Framework for Lifelong Program Analysis
59 http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html
63 Download and Installation Instructions:
64 llvm/docs/GettingStarted.html
67 llvm/docs/CommandGuide/CommandGuide.html
69 LLVM Assembly Language:
70 llvm/docs/LangRef.html
72 LLVM Test Suite Guide:
73 llvm/docs/TestingGuide.html
75 LLVM Programming Documentation:
77 LLVM Programmers Manual:
78 llvm/docs/ProgrammersManual.html
81 llvm/docs/WritingAnLLVMPass.html
83 Alias Analysis in LLVM:
84 llvm/docs/AliasAnalysis.html
87 llvm/docs/CommandLine.html
90 llvm/docs/CodingStandards.html
95 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
98 llvm/docs/OpenProjects.html
100 Creating a new LLVM Project:
101 llvm/docs/Projects.html
105 There are three mailing lists for providing LLVM users with information:
107 (1) LLVM Announcements List:
108 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
110 This is a low volume list that provides important announcements regarding
111 LLVM. It is primarily intended to announce new releases, major updates to
112 the software, etc. This list is highly recommended for anyone that uses
115 (2) LLVM Developers List:
116 http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
118 This list is for people who want to be included in technical discussions
119 of LLVM. People post to this list when they have questions about writing
120 code for or using the LLVM tools. It is relatively low volume.
122 (3) LLVM Commits List
123 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
125 This list contains all commit messages that are made when LLVM developers
126 commit code changes to the CVS archive. It is useful for those who want to
127 stay on the bleeding edge of LLVM development. This list is very high