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 </dl>
 161
 162 <h3>
 163 LLVM Programming Documentation:
 164 </h3>
 165
 166 <dl compact>
 167     <dt>
 168     LLVM Programmers Manual:
 169     <dd>
 170         <a href="ProgrammersManual.html"> llvm/docs/ProgrammersManual.html</a>
 171         <p>
 172
 173     <dt>
 174     Writing an LLVM Pass:
 175     <dd>
 176         <a href="WritingAnLLVMPass.html"> llvm/docs/WritingAnLLVMPass.html</a>
 177         <p>
 178
 179     <dt>
 180     Alias Analysis in LLVM:
 181     <dd>
 182         <a href="AliasAnalysis.html"> llvm/docs/AliasAnalysis.html</a>
 183         <p>
 184
 185     <dt>
 186     The Stacker Cronicles
 187     <dd>
 188         <a href="Stacker.html">The Stacker Cronicles</a>
 189    - This document describes both the Stacker language and
 190                     LLVM frontend, but also some details about LLVM useful for
 191                     those writing front-ends.<p>
 192
 193
 194     <dt>
 195     Command Line Library:
 196     <dd>
 197         <a href="CommandLine.html"> llvm/docs/CommandLine.html</a>
 198         <p>
 199
 200     <dt>
 201     Coding Standards:
 202     <dd>
 203         <a href="CodingStandards.html"> llvm/docs/CodingStandards.html</a>
 204         <p>
 205 </dl>
 206
 207 <h3>
 208 Other LLVM Resources:
 209 </h3>
 210
 211 <dl compact>
 212     <dt>
 213     Building the LLVM C/C++ front-end:
 214     <dd>
 215       <a href="CFEBuildInstrs.html">llvm/docs/CFEBuildInstrs.html</a>
 216       <p>
 217     <dt>
 218     Submitting a Bug:
 219     <dd>
 220         <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
 221         http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
 222         <p>
 223
 224     <dt>
 225     Open Projects:
 226     <dd>
 227         <a href="OpenProjects.html"> llvm/docs/OpenProjects.html</a>
 228         <p>
 229
 230     <dt>
 231     Creating a new LLVM Project:
 232     <dd>
 233         <a href="Projects.html"> llvm/docs/Projects.html</a>
 234         <p>
 235 </dl>
 236
 237 <hr>
 238
 239 <h2>
 240 Mailing Lists
 241 </h2>
 242 There are three mailing lists for providing LLVM users with information:
 243
 244 <ol>
 245     <li> LLVM Announcements List:<br>
 246     <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
 247     http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce</a>
 248
 249     <p>
 250     This is a low volume list that provides important announcements regarding
 251     LLVM.  It is primarily intended to announce new releases, major updates to
 252     the software, etc.  This list is highly recommended for anyone that uses
 253     LLVM.
 254     </p>
 255
 256     <li> LLVM Developers List:<br>
 257     <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">
 258     http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev</a>
 259
 260     <p>
 261     This list is for people who want to be included in technical discussions
 262     of LLVM.  People post to this list when they have questions about writing
 263     code for or using the LLVM tools.  It is relatively low volume.
 264     </p>
 265
 266     <li> LLVM Commits List<br>
 267     <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">
 268     http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits</a>
 269
 270     <p>
 271     This list contains all commit messages that are made when LLVM developers
 272     commit code changes to the CVS archive.  It is useful for those who want to
 273     stay on the bleeding edge of LLVM development. This list is very high
 274     volume.
 275     </p>
 276 </ol>
 277 </body>
 278 </html>
 279