-Welcome to LLVM!
-This file provides the location of all important LLVM documentation. In
-particular, you should read the license information and the installation
-directions before you begin using LLVM.
+Low Level Virtual Machine (LLVM)
+================================
-After that, there are several technical references that will help you use LLVM.
-Consult them as necessary.
+This directory and its subdirectories contain source code for the Low Level
+Virtual Machine, a toolkit for the construction of highly optimized compilers,
+optimizers, and runtime environments.
-Finally, you can find information on how to communicate with the LLVM
-developers and LLVM community. This is of primary interest if you wish to
-submit a bug, supply a patch, or just keep current with what's going on with
-LLVM.
+LLVM is open source software. You may freely distribute it under the terms of
+the license agreement found in LICENSE.txt.
-Introductory Literature:
+Please see the HTML documentation provided in docs/index.html for further
+assistance with LLVM.
- LLVM Home Page:
- http://llvm.cs.uiuc.edu
-
- License Information:
- llvm/LICENSE.txt
-
- Release Notes:
- llvm/docs/ReleaseNotes.html
-
-LLVM Design:
-
- The LLVM Instruction Set and Compilation Strategy:
- http://llvm.cs.uiuc.edu/pubs/2002-08-09-LLVMCompilationStrategy.html
-
-LLVM User Guides:
-
- Download and Installation Instructions:
- llvm/docs/GettingStarted.html
-
- LLVM Command Guide:
- llvm/docs/CommandGuide/CommandGuide.html
-
- LLVM Assembly Language:
- llvm/docs/LangRef.html
-
- LLVM Test Suite Guide:
- llvm/docs/TestingGuide.html
-
-LLVM Programming Documentation:
-
- LLVM Programmers Manual:
- llvm/docs/ProgrammersManual.html
-
- Writing an LLVM Pass:
- llvm/docs/WritingAnLLVMPass.html
-
- Alias Analysis in LLVM:
- llvm/docs/AliasAnalysis.html
-
- Command Line Library:
- llvm/docs/CommandLine.html
-
- Coding Standards:
- llvm/docs/CodingStandards.html
-
-LLVM Community:
-
- Submitting a Bug:
- http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
-
- Open Projects:
- llvm/docs/OpenProjects.html
-
- Creating a new LLVM Project:
- llvm/docs/Projects.html
-
- Mailing Lists:
- There are several mailing lists providing LLVM users with
- information:
-
- o LLVM Announcements List:
- http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
-
- This is a low volume list that provides
- important announcements regarding LLVM. It is
- primarily intended to announce new releases,
- major updates to the software, etc. This list
- is highly recommended for anyone that uses LLVM.
-
-
- o LLVM Developers List:
- http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
-
- This list is for people who want to be included
- in technical discussions of LLVM. People post
- to this list when they have questions about
- writing code for or using the LLVM tools. It
- is low volume.
-
- o LLVM Commits List
- http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
-
- This list contains all commit messages that are
- made when LLVM developers commit code changes
- to the CVS archive. It is useful for those who
- want to stay on the bleeding edge of LLVM
- development.
-
- This list is very high volume.
+If you're writing a package for LLVM, see docs/Packaging.html for our
+suggestions.