1
- ##===----------------------------------------------------------------------===##
2
- #
3
- # The LLVM Compiler Infrastructure
4
- #
5
- # This file was developed by the LLVM research group and is distributed under
6
- # the University of Illinois Open Source License. See LICENSE.TXT for details.
7
- #
8
- ##===----------------------------------------------------------------------===##
1
+ The LLVM Compiler Infrastructure
2
+ http://llvm.cs.uiuc.edu
9
3
10
4
Welcome to LLVM!
5
+ -----------------
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.
11
11
12
- This file provides the ___location of all important LLVM documentation. In
13
- particular, you should read the license information and the installation
14
- directions before you begin using LLVM.
15
12
16
- After that, there are several technical references that will help you use LLVM.
17
- Consult them as necessary.
13
+ Getting Started with LLVM
14
+ -------------------------
18
15
19
- Finally, you can find information on how to communicate with the LLVM
20
- developers and LLVM community. This is of primary interest if you wish to
21
- submit a bug, supply a patch, or just keep current with what's going on with
22
- LLVM.
16
+ (1) For license information:
17
+ llvm/LICENSE.txt
23
18
24
- Introductory Literature:
19
+ (2) Installing and compiling LLVM:
20
+ llvm/docs/GettingStarted.html
25
21
26
- LLVM Home Page :
27
- http://llvm.cs.uiuc.edu
22
+ (3) Learn about features and limitations of this release :
23
+ llvm/docs/ReleaseNotes.html
28
24
29
- License Information :
30
- llvm/LICENSE.txt
25
+ (4) Learn how to write a pass within the LLVM system :
26
+ llvm/docs/WritingAnLLVMPass.html
31
27
32
- Release Notes:
33
- llvm/docs/ReleaseNotes.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
32
35
- LLVM Design:
36
33
37
- LLVM: A Compilation Framework for Lifelong Program Analysis &
38
- Transformation
39
- http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html
34
+ Getting Help with LLVM
35
+ ----------------------
36
+
37
+ (1) If you have questions or development problems not answered in the
38
+ documentation, send e-mail to
[email protected] . This mailing list is
39
+ monitored by all the people in the LLVM group at Illinois, and you should
40
+ expect prompt first responses.
41
+
42
+ (2) To report a bug, submit a bug report as described in the document:
43
+ http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
44
+
45
+ (3) We now use Bugzilla to track bugs, so you can check the status of
46
+ previous bugs at:
47
+ <FIXME: WHERE DO THEY GO???>
48
+
49
+
50
+ LLVM Documentation
51
+ ------------------
52
+
53
+ All the documents mentioned below except the design overview tech report
54
+ are include as part of the LLVM release (in llvm/docs/*):
55
+
56
+ LLVM Design Overview:
57
+ LLVM : A Compilation Framework for Lifelong Program Analysis
58
+ and Transformation:
59
+ http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html
40
60
41
61
LLVM User Guides:
42
62
@@ -69,7 +89,7 @@ LLVM Programming Documentation:
69
89
Coding Standards:
70
90
llvm/docs/CodingStandards.html
71
91
72
- LLVM Community :
92
+ Other LLVM Resources :
73
93
74
94
Submitting a Bug:
75
95
http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
@@ -80,37 +100,30 @@ LLVM Community:
80
100
Creating a new LLVM Project:
81
101
llvm/docs/Projects.html
82
102
83
- Mailing Lists:
84
- There are several mailing lists providing LLVM users with
85
- information:
86
-
87
- o LLVM Announcements List:
88
- http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
89
-
90
- This is a low volume list that provides
91
- important announcements regarding LLVM. It is
92
- primarily intended to announce new releases,
93
- major updates to the software, etc. This list
94
- is highly recommended for anyone that uses LLVM.
103
+ Mailing Lists
104
+ --------------
105
+ There are three mailing lists for providing LLVM users with information:
95
106
107
+ (1) LLVM Announcements List:
108
+ http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
96
109
97
- o LLVM Developers List:
98
- http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
110
+ This is a low volume list that provides important announcements regarding
111
+ LLVM. It is primarily intended to announce new releases, major updates to
112
+ the software, etc. This list is highly recommended for anyone that uses
113
+ LLVM.
99
114
100
- This list is for people who want to be included
101
- in technical discussions of LLVM. People post
102
- to this list when they have questions about
103
- writing code for or using the LLVM tools. It
104
- is low volume.
115
+ (2) LLVM Developers List:
116
+ http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
105
117
106
- o LLVM Commits List
107
- http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
118
+ This list is for people who want to be included in technical discussions
119
+ of LLVM. People post to this list when they have questions about writing
120
+ code for or using the LLVM tools. It is relatively low volume.
108
121
109
- This list contains all commit messages that are
110
- made when LLVM developers commit code changes
111
- to the CVS archive. It is useful for those who
112
- want to stay on the bleeding edge of LLVM
113
- development.
122
+ (3) LLVM Commits List
123
+ http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
114
124
115
- This list is very high volume.
125
+ This list contains all commit messages that are made when LLVM developers
126
+ commit code changes to the CVS archive. It is useful for those who want to
127
+ stay on the bleeding edge of LLVM development. This list is very high
128
+ volume.
116
129
0 commit comments