3 <title>The LLVM Compiler Infrastructure</title>
9 The LLVM Compiler Infrastructure
11 <a href="http://llvm.cs.uiuc.edu">http://llvm.cs.uiuc.edu</a>
17 <h2>Welcome to LLVM!</h2>
19 This file is intended to do four things:
21 <li>help you get started using LLVM;</li>
23 <li>tell you how to get questions about LLVM answered;</li>
25 <li>tell you where to find documentation for different kinds of questions;
28 <li>tell you about three LLVM-related mailing lists.</li>
35 Getting Started with LLVM
40 For license information:
42 <a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm/LICENSE.TXT?rev=HEAD&content-type=text/x-cvsweb-markup">llvm/LICENSE.TXT</a>
46 Installing and compiling LLVM:
48 <a href="GettingStarted.html">llvm/docs/GettingStarted.html</a>
52 Learn about features and limitations of this release:
54 <a href="ReleaseNotes.html">llvm/docs/ReleaseNotes.html</a>
58 Learn how to write a pass within the LLVM system:
60 <a href="WritingAnLLVMPass.html">llvm/docs/WritingAnLLVMPass.html </a>
64 Learn how to start a new development project using LLVM, where your
65 new source code can live anywhere (outside or inside the LLVM tree),
66 while using LLVM header files and libraries:
68 <a href="Projects.html">llvm/docs/Projects.html</a>
74 Getting Help with LLVM
79 If you have questions or development problems not answered in the
80 documentation, send e-mail to llvmdev@cs.uiuc.edu. This mailing list is
81 monitored by all the people in the LLVM group at Illinois, and you
82 should expect prompt first responses.
86 To report a bug, submit a bug report as described in the document:
87 <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
88 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
92 We now use Bugzilla to track bugs, so you can check the status of
94 <a href="http://llvm.cs.uiuc.edu/bugs/query.cgi">
95 http://llvm.cs.uiuc.edu/bugs/query.cgi </a>
105 All the documents mentioned below except the design overview tech report
106 are included as part of the LLVM release (in llvm/docs/*):
109 LLVM Design Overview:
114 LLVM: A Compilation Framework for Lifelong Program Analysis
117 <a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">
118 http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html </a>
128 Download and Installation Instructions:
130 <a href="GettingStarted.html"> llvm/docs/GettingStarted.html</a>
136 <a href="CommandGuide/index.html">
137 llvm/docs/CommandGuide/index.html</a>
141 LLVM Assembly Language:
143 <a href="LangRef.html"> llvm/docs/LangRef.html</a>
147 LLVM Test Suite Guide:
149 <a href="TestingGuide.html"> llvm/docs/TestingGuide.html</a>
154 LLVM Programming Documentation:
159 LLVM Programmers Manual:
161 <a href="ProgrammersManual.html">llvm/docs/ProgrammersManual.html</a>
165 Writing an LLVM Pass:
167 <a href="WritingAnLLVMPass.html">llvm/docs/WritingAnLLVMPass.html</a>
171 Alias Analysis in LLVM:
173 <a href="AliasAnalysis.html">llvm/docs/AliasAnalysis.html</a>
177 Source Level Debugging with LLVM:
179 <a href="SourceLevelDebugging.html">llvm/docs/SourceLevelDebugging.html</a>
184 TableGen Fundamentals:
186 <a href="TableGenFundamentals.html">llvm/docs/TableGenFundamentals.html</a>
191 The Stacker Cronicles
193 <a href="Stacker.html">The Stacker Cronicles</a>
194 - This document describes both the Stacker language and
195 LLVM frontend, but also some details about LLVM useful for
196 those writing front-ends.<p>
200 Command Line Library:
202 <a href="CommandLine.html">llvm/docs/CommandLine.html</a>
208 <a href="ExtendingLLVM.html">llvm/docs/ExtendingLLVM.html</a>
214 <a href="CodingStandards.html">llvm/docs/CodingStandards.html</a>
218 <h3>Other LLVM Resources</h3>
222 Building the LLVM C/C++ front-end:
224 <a href="CFEBuildInstrs.html">llvm/docs/CFEBuildInstrs.html</a>
229 <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
230 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
236 <a href="OpenProjects.html">llvm/docs/OpenProjects.html</a>
240 Creating a new LLVM Project:
242 <a href="Projects.html">llvm/docs/Projects.html</a>
248 <h2>Mailing Lists</h2>
250 There are three mailing lists for providing LLVM users with information:
253 <li> LLVM Announcements List:<br>
254 <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
255 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce</a>
258 This is a low volume list that provides important announcements regarding
259 LLVM. It is primarily intended to announce new releases, major updates to
260 the software, etc. This list is highly recommended for anyone that uses
264 <li> LLVM Developers List:<br>
265 <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">
266 http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev</a>
269 This list is for people who want to be included in technical discussions
270 of LLVM. People post to this list when they have questions about writing
271 code for or using the LLVM tools. It is relatively low volume.
274 <li> LLVM Commits List<br>
275 <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">
276 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits</a>
279 This list contains all commit messages that are made when LLVM developers
280 commit code changes to the CVS archive. It is useful for those who want to
281 stay on the bleeding edge of LLVM development. This list is very high