README.txt

   1 Welcome to LLVM!
   2
   3 This file provides the location of all important LLVM documentation.  In
   4 particular, you should read the license information and the installation
   5 directions before you begin using LLVM.
   6
   7 After that, there are several technical references that will help you use LLVM.
   8 Consult them as necessary.
   9
  10 Finally, you can find information on how to communicate with the LLVM
  11 developers and LLVM community.  This is of primary interest if you wish to
  12 submit a bug, supply a patch, or just keep current with what's going on with
  13 LLVM.
  14
  15 Introductory Literature:
  16
  17         LLVM Home Page:
  18                 http://llvm.cs.uiuc.edu
  19
  20         License Information:
  21                 llvm/LICENSE.txt
  22
  23         Release Notes:
  24                 llvm/docs/ReleaseNotes.html
  25
  26 LLVM Design:
  27
  28          The LLVM Instruction Set and Compilation Strategy:
  29                 http://llvm.cs.uiuc.edu/pubs/2002-08-09-LLVMCompilationStrategy.html
  30
  31 LLVM User Guides:
  32
  33         Download and Installation Instructions:
  34                 llvm/docs/GettingStarted.html
  35
  36         LLVM Command Guide:
  37                 llvm/docs/CommandGuide/CommandGuide.html
  38
  39         LLVM Assembly Language:
  40                 llvm/docs/LangRef.html
  41
  42         LLVM Test Suite Guide:
  43                 llvm/docs/TestingGuide.html
  44
  45 LLVM Programming Documentation:
  46
  47         LLVM Programmers Manual:
  48                 llvm/docs/ProgrammersManual.html
  49
  50         Writing an LLVM Pass:
  51                 llvm/docs/WritingAnLLVMPass.html
  52
  53         Alias Analysis in LLVM:
  54                 llvm/docs/AliasAnalysis.html
  55
  56         Command Line Library:
  57                 llvm/docs/CommandLine.html
  58
  59         Coding Standards:
  60                 llvm/docs/CodingStandards.html
  61
  62 LLVM Community:
  63
  64         Submitting a Bug:
  65                 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
  66
  67         Open Projects:
  68                 llvm/docs/OpenProjects.html
  69
  70         Creating a new LLVM Project:
  71                 llvm/docs/Projects.html
  72
  73         Mailing Lists:
  74                 There are several mailing lists providing LLVM users with
  75                 information:
  76
  77                         o LLVM Announcements List:
  78                         http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
  79
  80                                 This is a low volume list that provides
  81                                 important announcements regarding LLVM.  It is
  82                                 primarily intended to announce new releases,
  83                                 major updates to the software, etc.  This list
  84                                 is highly recommended for anyone that uses LLVM.
  85
  86
  87                         o LLVM Developers List:
  88                         http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
  89
  90                                 This list is for people who want to be included
  91                                 in technical discussions of LLVM.  People post
  92                                 to this list when they have questions about
  93                                 writing code for or using the LLVM tools.  It
  94                                 is low volume.
  95
  96                         o LLVM Commits List
  97                         http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
  98
  99                                 This list contains all commit messages that are
 100                                 made when LLVM developers commit code changes
 101                                 to the CVS archive.  It is useful for those who
 102                                 want to stay on the bleeding edge of LLVM
 103                                 development.
 104
 105                                 This list is very high volume.
 106