X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=blobdiff_plain;f=README.txt;h=2ebe271b8e5143bd7d0922990a28a4933ca90b99;hp=a3bfb7c42dc206a7ca4a1087fbbe5130f0545e47;hb=3d0c7231fd5fc6af4407c9b2e3267b1acba2570f;hpb=85bf334765df9259b06e7c39669c9365ed3acc31 diff --git a/README.txt b/README.txt index a3bfb7c42dc..2ebe271b8e5 100644 --- a/README.txt +++ b/README.txt @@ -1,74 +1,15 @@ -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 the Low Level +Virtual Machine, 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: - License Information: - llvm/LICENSE.txt - - 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: - llvm/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 HTML documentation provided in docs/index.html for further +assistance with LLVM. +If you're writing a package for LLVM, see docs/Packaging.html for our +suggestions.