Skip to content

Commit f924987

Browse files
author
John Criswell
committed
HTML version of README.txt
llvm-svn: 9468
1 parent 4452c27 commit f924987

File tree

1 file changed

+242
-0
lines changed

1 file changed

+242
-0
lines changed

‎llvm/docs/index.html

Lines changed: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
<html>
2+
<title>
3+
The LLVM Compiler Infrastructure
4+
</title>
5+
6+
<body>
7+
8+
<center>
9+
<h1>
10+
The LLVM Compiler Infrastructure
11+
<br>
12+
<a href="http://llvm.cs.uiuc.edu">http://llvm.cs.uiuc.edu</a>
13+
</h1>
14+
</center>
15+
16+
<hr>
17+
18+
<h2>
19+
Welcome to LLVM!
20+
</h2>
21+
This file is intended to do four things:
22+
<ol>
23+
<li>
24+
help you get started using LLVM;
25+
</li>
26+
27+
<li>
28+
tell you how to get questions about LLVM answered;
29+
</li>
30+
31+
<li>
32+
tell you where to find documentation for different kinds of questions; and
33+
</li>
34+
35+
<li>
36+
tell you about three LLVM-related mailing lists.
37+
</li>
38+
</ol>
39+
40+
41+
<hr>
42+
43+
<h2>
44+
Getting Started with LLVM
45+
</h2>
46+
47+
<dl compact>
48+
<dt>
49+
For license information:
50+
<dd>
51+
llvm/LICENSE.txt
52+
53+
<dt>
54+
Installing and compiling LLVM:
55+
<dd>
56+
llvm/docs/GettingStarted.html
57+
58+
<dt>
59+
Learn about features and limitations of this release:
60+
<dd>
61+
llvm/docs/ReleaseNotes.html
62+
63+
<dt>
64+
Learn how to write a pass within the LLVM system:
65+
<dd>
66+
llvm/docs/WritingAnLLVMPass.html
67+
68+
<dt>
69+
Learn how to start a new development project using LLVM, where your
70+
<dd>
71+
new source code can live anywhere (outside or inside the LLVM tree),
72+
while using LLVM header files and libraries:
73+
llvm/docs/Projects.html
74+
</dl>
75+
76+
<hr>
77+
78+
<h2>
79+
Getting Help with LLVM
80+
</h2>
81+
82+
<ol>
83+
<li>
84+
If you have questions or development problems not answered in the
85+
documentation, send e-mail to [email protected]. This mailing list is
86+
monitored by all the people in the LLVM group at Illinois, and you should
87+
expect prompt first responses.
88+
</li>
89+
90+
<li>
91+
To report a bug, submit a bug report as described in the document:
92+
http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
93+
</li>
94+
95+
<li>
96+
We now use Bugzilla to track bugs, so you can check the status of
97+
previous bugs at:
98+
<a href="http://llvm.cs.uiuc.edu/bugs/query.cgi">
99+
http://llvm.cs.uiuc.edu/bugs/query.cgi </a>
100+
</li>
101+
</ol>
102+
103+
<hr>
104+
105+
<h2>
106+
LLVM Documentation
107+
</h2>
108+
109+
All the documents mentioned below except the design overview tech report
110+
are included as part of the LLVM release (in llvm/docs/*):
111+
112+
<h3>
113+
LLVM Design Overview:
114+
</h3>
115+
116+
<dl compact>
117+
<dt>
118+
LLVM : A Compilation Framework for Lifelong Program Analysis
119+
and Transformation:
120+
<dd>
121+
http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html
122+
123+
</dl>
124+
125+
<h3>
126+
LLVM User Guides:
127+
</h3>
128+
129+
<dl compact>
130+
<dt>
131+
Download and Installation Instructions:
132+
<dd>
133+
llvm/docs/GettingStarted.html
134+
135+
<dt>
136+
LLVM Command Guide:
137+
<dd>
138+
llvm/docs/CommandGuide/CommandGuide.html
139+
140+
<dt>
141+
LLVM Assembly Language:
142+
<dd>
143+
llvm/docs/LangRef.html
144+
145+
<dt>
146+
LLVM Test Suite Guide:
147+
<dd>
148+
llvm/docs/TestingGuide.html
149+
</dl>
150+
151+
<h3>
152+
LLVM Programming Documentation:
153+
</h3>
154+
155+
<dl compact>
156+
<dt>
157+
LLVM Programmers Manual:
158+
<dd>
159+
llvm/docs/ProgrammersManual.html
160+
161+
<dt>
162+
Writing an LLVM Pass:
163+
<dd>
164+
llvm/docs/WritingAnLLVMPass.html
165+
166+
<dt>
167+
Alias Analysis in LLVM:
168+
<dd>
169+
llvm/docs/AliasAnalysis.html
170+
171+
<dt>
172+
Command Line Library:
173+
<dd>
174+
llvm/docs/CommandLine.html
175+
176+
<dt>
177+
Coding Standards:
178+
<dd>
179+
llvm/docs/CodingStandards.html
180+
</dl>
181+
182+
<h3>
183+
Other LLVM Resources:
184+
</h3>
185+
186+
<dl compact>
187+
<dt>
188+
Submitting a Bug:
189+
<dd>
190+
http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
191+
192+
<dt>
193+
Open Projects:
194+
<dd>
195+
llvm/docs/OpenProjects.html
196+
197+
<dt>
198+
Creating a new LLVM Project:
199+
<dd>
200+
llvm/docs/Projects.html
201+
</dl>
202+
203+
<hr>
204+
205+
<h2>
206+
Mailing Lists
207+
</h2>
208+
There are three mailing lists for providing LLVM users with information:
209+
210+
<ol>
211+
<li> LLVM Announcements List:<br>
212+
http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
213+
214+
<p>
215+
This is a low volume list that provides important announcements regarding
216+
LLVM. It is primarily intended to announce new releases, major updates to
217+
the software, etc. This list is highly recommended for anyone that uses
218+
LLVM.
219+
</p>
220+
221+
<li> LLVM Developers List:<br>
222+
http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
223+
224+
<p>
225+
This list is for people who want to be included in technical discussions
226+
of LLVM. People post to this list when they have questions about writing
227+
code for or using the LLVM tools. It is relatively low volume.
228+
</p>
229+
230+
<li> LLVM Commits List<br>
231+
http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
232+
233+
<p>
234+
This list contains all commit messages that are made when LLVM developers
235+
commit code changes to the CVS archive. It is useful for those who want to
236+
stay on the bleeding edge of LLVM development. This list is very high
237+
volume.
238+
</p>
239+
</ol>
240+
</body>
241+
</html>
242+

0 commit comments

Comments
 (0)