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