docs/index.html

   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         <a href="../LICENSE.TXT">llvm/LICENSE.TXT</a>
  52         <p>
  53
  54     <dt>
  55     Installing and compiling LLVM:
  56     <dd>
  57         <a href="GettingStarted.html">llvm/docs/GettingStarted.html</a>
  58         <p>
  59
  60     <dt>
  61     Learn about features and limitations of this release:
  62     <dd>
  63         <a href="ReleaseNotes.html">llvm/docs/ReleaseNotes.html</a>
  64         <p>
  65
  66     <dt>
  67     Learn how to write a pass within the LLVM system:
  68     <dd>
  69         <a href="WritingAnLLVMPass.html">llvm/docs/WritingAnLLVMPass.html </a>
  70         <p>
  71
  72     <dt>
  73     Learn how to start a new development project using LLVM, where your
  74     new source code can live anywhere (outside or inside the LLVM tree),
  75     while using LLVM header files and libraries:
  76     <dd>
  77         <a href="Projects.html">llvm/docs/Projects.html</a>
  78 </dl>
  79
  80 <hr>
  81
  82 <h2>
  83 Getting Help with LLVM
  84 </h2>
  85
  86 <ol>
  87         <li>
  88         If you have questions or development problems not answered in the
  89         documentation, send e-mail to llvmdev@cs.uiuc.edu.  This mailing list is
  90         monitored by all the people in the LLVM group at Illinois, and you
  91         should expect prompt first responses.
  92         </li>
  93
  94         <li>
  95         To report a bug, submit a bug report as described in the document:
  96         <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
  97         http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
  98         </li>
  99
 100         <li>
 101         We now use Bugzilla to track bugs, so you can check the status of
 102         previous bugs at:
 103         <a href="http://llvm.cs.uiuc.edu/bugs/query.cgi">
 104         http://llvm.cs.uiuc.edu/bugs/query.cgi </a>
 105         </li>
 106 </ol>
 107
 108 <hr>
 109
 110 <h2>
 111 LLVM Documentation
 112 </h2>
 113
 114 All the documents mentioned below except the design overview tech report
 115 are included as part of the LLVM release (in llvm/docs/*):
 116
 117 <h3>
 118 LLVM Design Overview:
 119 </h3>
 120
 121 <dl compact>
 122     <dt>
 123     LLVM : A Compilation Framework for Lifelong Program Analysis
 124     and Transformation:
 125     <dd>
 126         <a href="http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html">
 127         http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html </a>
 128
 129 </dl>
 130
 131 <h3>
 132 LLVM User Guides:
 133 </h3>
 134
 135 <dl compact>
 136     <dt>
 137     Download and Installation Instructions:
 138     <dd>
 139         <a href="GettingStarted.html"> llvm/docs/GettingStarted.html</a>
 140         <p>
 141
 142     <dt>
 143     LLVM Command Guide:
 144     <dd>
 145         <a href="CommandGuide/index.html">
 146         llvm/docs/CommandGuide/index.html</a>
 147         <p>
 148
 149     <dt>
 150     LLVM Assembly Language:
 151     <dd>
 152         <a href="LangRef.html"> llvm/docs/LangRef.html</a>
 153         <p>
 154
 155     <dt>
 156     LLVM Test Suite Guide:
 157     <dd>
 158         <a href="TestingGuide.html"> llvm/docs/TestingGuide.html</a>
 159         <p>
 160
 161     <dt>
 162     Comparison of LLVM to other frameworks:
 163     <dd>
 164         <a href="LLVMVsTheWorld.html"> llvm/docs/LLVMVsTheWorld.html</a>
 165         <p>
 166 </dl>
 167
 168 <h3>
 169 LLVM Programming Documentation:
 170 </h3>
 171
 172 <dl compact>
 173     <dt>
 174     LLVM Programmers Manual:
 175     <dd>
 176         <a href="ProgrammersManual.html"> llvm/docs/ProgrammersManual.html</a>
 177         <p>
 178
 179     <dt>
 180     Writing an LLVM Pass:
 181     <dd>
 182         <a href="WritingAnLLVMPass.html"> llvm/docs/WritingAnLLVMPass.html</a>
 183         <p>
 184
 185     <dt>
 186     Alias Analysis in LLVM:
 187     <dd>
 188         <a href="AliasAnalysis.html"> llvm/docs/AliasAnalysis.html</a>
 189         <p>
 190
 191     <dt>
 192     Command Line Library:
 193     <dd>
 194         <a href="CommandLine.html"> llvm/docs/CommandLine.html</a>
 195         <p>
 196
 197     <dt>
 198     Coding Standards:
 199     <dd>
 200         <a href="CodingStandards.html"> llvm/docs/CodingStandards.html</a>
 201         <p>
 202 </dl>
 203
 204 <h3>
 205 Other LLVM Resources:
 206 </h3>
 207
 208 <dl compact>
 209     <dt>
 210     Building the LLVM C/C++ front-end:
 211     <dd>
 212       <a href="CFEBuildInstrs.html">llvm/docs/CFEBuildInstrs.html</a>
 213       <p>
 214     <dt>
 215     Submitting a Bug:
 216     <dd>
 217         <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
 218         http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
 219         <p>
 220
 221     <dt>
 222     Open Projects:
 223     <dd>
 224         <a href="OpenProjects.html"> llvm/docs/OpenProjects.html</a>
 225         <p>
 226
 227     <dt>
 228     Creating a new LLVM Project:
 229     <dd>
 230         <a href="Projects.html"> llvm/docs/Projects.html</a>
 231         <p>
 232 </dl>
 233
 234 <hr>
 235
 236 <h2>
 237 Mailing Lists
 238 </h2>
 239 There are three mailing lists for providing LLVM users with information:
 240
 241 <ol>
 242     <li> LLVM Announcements List:<br>
 243     <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
 244     http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce</a>
 245
 246     <p>
 247     This is a low volume list that provides important announcements regarding
 248     LLVM.  It is primarily intended to announce new releases, major updates to
 249     the software, etc.  This list is highly recommended for anyone that uses
 250     LLVM.
 251     </p>
 252
 253     <li> LLVM Developers List:<br>
 254     <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">
 255     http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev</a>
 256
 257     <p>
 258     This list is for people who want to be included in technical discussions
 259     of LLVM.  People post to this list when they have questions about writing
 260     code for or using the LLVM tools.  It is relatively low volume.
 261     </p>
 262
 263     <li> LLVM Commits List<br>
 264     <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">
 265     http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits</a>
 266
 267     <p>
 268     This list contains all commit messages that are made when LLVM developers
 269     commit code changes to the CVS archive.  It is useful for those who want to
 270     stay on the bleeding edge of LLVM development. This list is very high
 271     volume.
 272     </p>
 273 </ol>
 274 </body>
 275 </html>
 276