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