3 This file provides the location of all important LLVM documentation. In
4 particular, you should read the license information and the installation
5 directions before you begin using LLVM.
7 After that, there are several technical references that will help you use LLVM.
8 Consult them as necessary.
10 Finally, you can find information on how to communicate with the LLVM
11 developers and LLVM community. This is of primary interest if you wish to
12 submit a bug, supply a patch, or just keep current with what's going on with
15 Introductory Literature:
18 http://llvm.cs.uiuc.edu
24 llvm/docs/ReleaseNotes.html
28 The LLVM Instruction Set and Compilation Strategy:
29 http://llvm.cs.uiuc.edu/pubs/2002-08-09-LLVMCompilationStrategy.html
33 Download and Installation Instructions:
34 llvm/docs/GettingStarted.html
37 llvm/docs/CommandGuide/CommandGuide.html
39 LLVM Assembly Language:
40 llvm/docs/LangRef.html
42 LLVM Test Suite Guide:
43 llvm/docs/TestingGuide.html
45 LLVM Programming Documentation:
47 LLVM Programmers Manual:
48 llvm/docs/ProgrammersManual.html
51 llvm/docs/WritingAnLLVMPass.html
53 Alias Analysis in LLVM:
54 llvm/docs/AliasAnalysis.html
57 llvm/docs/CommandLine.html
60 llvm/docs/CodingStandards.html
65 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
68 llvm/docs/OpenProjects.html
70 Creating a new LLVM Project:
71 llvm/docs/Projects.html
74 There are several mailing lists providing LLVM users with
77 o LLVM Announcements List:
78 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
80 This is a low volume list that provides
81 important announcements regarding LLVM. It is
82 primarily intended to announce new releases,
83 major updates to the software, etc. This list
84 is highly recommended for anyone that uses LLVM.
87 o LLVM Developers List:
88 http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
90 This list is for people who want to be included
91 in technical discussions of LLVM. People post
92 to this list when they have questions about
93 writing code for or using the LLVM tools. It
97 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
99 This list contains all commit messages that are
100 made when LLVM developers commit code changes
101 to the CVS archive. It is useful for those who
102 want to stay on the bleeding edge of LLVM
105 This list is very high volume.