X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=blobdiff_plain;f=README.txt;h=7cfb1640995fdb3f8405a7fe817f8578988feba6;hp=7189c71d72391dcf6255f7dff48938c1bd84361b;hb=ac6ac4cb6c567726b5ea8c823906a4ab6c8c089a;hpb=6a513d8ad13ae250d8413fb2169468928475e2c8 diff --git a/README.txt b/README.txt index 7189c71d723..7cfb1640995 100644 --- a/README.txt +++ b/README.txt @@ -1,81 +1,17 @@ -Welcome to LLVM! +Low Level Virtual Machine (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. +This directory and its subdirectories contain source code for LLVM, +a toolkit for the construction of highly optimized compilers, +optimizers, and runtime environments. -After that, there are several technical references that will help you use LLVM. -Consult them as necessary. +LLVM is open source software. You may freely distribute it under the terms of +the license agreement found in LICENSE.txt. -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. - -Introductory Literature: - LLVM Home Page: - http://llvm.cs.uiuc.edu - - License Information: - llvm/LICENSE.txt - - Downloading and Installation Instructions: - llvm/docs/GettingStarted.html - - Release Notes: - llvm/docs/ReleaseNotes.html - -Technical Reference: - Command Documentation: - llvm/docs/CommandGuide/CommandGuide.html - - Using the LLVM Test Suite: - llvm/docs/TestingGuide.html - - LLVM Assembly Language: - llvm/docs/LangRef.html - - LLVM Source Code Tree: - llvm/docs/ProgrammersManual.html - - Coding Standards: - llvm/docs/CodingStandards.html - -LLVM Community: - Submitting a Bug: - http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.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. +Please see the documentation provided in docs/ for further +assistance with LLVM, and in particular docs/GettingStarted.rst for getting +started with LLVM and docs/README.txt for an overview of LLVM's +documentation setup. +If you are writing a package for LLVM, see docs/Packaging.rst for our +suggestions.