docs/index.html

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