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         License Information:
  17                 llvm/LICENSE.txt
  18
  19         Installation Instructions:
  20                 llvm/docs/GettingStarted.html
  21
  22         Release Notes:
  23                 llvm/docs/ReleaseNotes.html
  24
  25 Technical Reference:
  26         Command Documentation:
  27                 llvm/docs/CommandGuide/CommandGuide.html
  28
  29         Using the LLVM Test Suite:
  30                 llvm/docs/TestingGuide.html
  31
  32         LLVM Assembly Language:
  33                 llvm/docs/LangRef.html
  34
  35         LLVM Source Code Tree:
  36                 llvm/docs/ProgrammersManual.html
  37
  38         Coding Standards:
  39                 llvm/docs/CodingStandards.html
  40
  41 LLVM Community:
  42         Submitting a Bug:
  43                 llvm/docs/HowToSubmitABug.html
  44
  45         Mailing Lists:
  46                 There are several mailing lists providing LLVM users with information:
  47
  48                         o LLVM Announcements List:
  49                         http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
  50
  51                                 This is a low volume list that provides important announcements
  52                                 regarding LLVM.  It is primarily intended to announce new
  53                                 releases, major updates to the software, etc.  This list is
  54                                 highly recommended for anyone that uses LLVM.
  55
  56
  57                         o LLVM Developers List:
  58                         http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
  59
  60                                 This list is for people who want to be included in technical
  61                                 discussions of LLVM.  People post to this list when they have
  62                                 questions about writing code for or using the LLVM tools.  It
  63                                 is low volume.
  64
  65                         o LLVM Commits List
  66                         http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
  67
  68                                 This list contains all commit messages that are made when LLVM
  69                                 developers commit code changes to the CVS archive.  It is
  70                                 useful for those who want to stay on the bleeding edge of LLVM
  71                                 development.
  72
  73                                 This list is very high volume.
  74