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 http://llvm.cs.uiuc.edu/bugs/query.cgi
52 All the documents mentioned below except the design overview tech report
53 are included as part of the LLVM release (in llvm/docs/*):
56 LLVM : A Compilation Framework for Lifelong Program Analysis
58 http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html
62 Download and Installation Instructions:
63 llvm/docs/GettingStarted.html
66 llvm/docs/CommandGuide/index.html
68 LLVM Assembly Language:
69 llvm/docs/LangRef.html
71 LLVM Test Suite Guide:
72 llvm/docs/TestingGuide.html
74 LLVM Programming Documentation:
76 LLVM Programmers Manual:
77 llvm/docs/ProgrammersManual.html
80 llvm/docs/WritingAnLLVMPass.html
82 Alias Analysis in LLVM:
83 llvm/docs/AliasAnalysis.html
86 llvm/docs/CommandLine.html
89 llvm/docs/CodingStandards.html
94 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
97 llvm/docs/OpenProjects.html
99 Creating a new LLVM Project:
100 llvm/docs/Projects.html
104 There are three mailing lists for providing LLVM users with information:
106 (1) LLVM Announcements List:
107 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
109 This is a low volume list that provides important announcements regarding
110 LLVM. It is primarily intended to announce new releases, major updates to
111 the software, etc. This list is highly recommended for anyone that uses
114 (2) LLVM Developers List:
115 http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
117 This list is for people who want to be included in technical discussions
118 of LLVM. People post to this list when they have questions about writing
119 code for or using the LLVM tools. It is relatively low volume.
121 (3) LLVM Commits List
122 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
124 This list contains all commit messages that are made when LLVM developers
125 commit code changes to the CVS archive. It is useful for those who want to
126 stay on the bleeding edge of LLVM development. This list is very high