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:
17 http://llvm.cs.uiuc.edu
22 Downloading and Installation Instructions:
23 llvm/docs/GettingStarted.html
26 llvm/docs/ReleaseNotes.html
29 Command Documentation:
30 llvm/docs/CommandGuide/CommandGuide.html
32 Using the LLVM Test Suite:
33 llvm/docs/TestingGuide.html
35 LLVM Assembly Language:
36 llvm/docs/LangRef.html
38 LLVM Source Code Tree:
39 llvm/docs/ProgrammersManual.html
42 llvm/docs/CodingStandards.html
46 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
49 There are several mailing lists providing LLVM users with
52 o LLVM Announcements List:
53 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
55 This is a low volume list that provides
56 important announcements regarding LLVM. It is
57 primarily intended to announce new releases,
58 major updates to the software, etc. This list
59 is highly recommended for anyone that uses LLVM.
62 o LLVM Developers List:
63 http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
65 This list is for people who want to be included
66 in technical discussions of LLVM. People post
67 to this list when they have questions about
68 writing code for or using the LLVM tools. It
72 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
74 This list contains all commit messages that are
75 made when LLVM developers commit code changes
76 to the CVS archive. It is useful for those who
77 want to stay on the bleeding edge of LLVM
80 This list is very high volume.