diff options
| author | John Criswell <criswell@uiuc.edu> | 2003-10-24 16:19:11 +0000 |
|---|---|---|
| committer | John Criswell <criswell@uiuc.edu> | 2003-10-24 16:19:11 +0000 |
| commit | c146250c263fe9c25126ce012abee29cfed8064c (patch) | |
| tree | 241831f424030a9ad26f5fa5d73a84f33c125aee | |
| parent | 0e7ed7840cfc9368577d9c601ab865125f3cf076 (diff) | |
HTML version of README.txt
git-svn-id: https://llvm.org/svn/llvm-project/llvm/branches/release_1@9468 91177308-0d34-0410-b5e6-96231b3b80d8
| -rw-r--r-- | docs/index.html | 242 |
1 files changed, 242 insertions, 0 deletions
diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000000..ae7e186057 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,242 @@ +<html> +<title> +The LLVM Compiler Infrastructure +</title> + +<body> + +<center> +<h1> + The LLVM Compiler Infrastructure + <br> + <a href="http://llvm.cs.uiuc.edu">http://llvm.cs.uiuc.edu</a> +</h1> +</center> + +<hr> + +<h2> +Welcome to LLVM! +</h2> +This file is intended to do four things: +<ol> + <li> + help you get started using LLVM; + </li> + + <li> + tell you how to get questions about LLVM answered; + </li> + + <li> + tell you where to find documentation for different kinds of questions; and + </li> + + <li> + tell you about three LLVM-related mailing lists. + </li> +</ol> + + +<hr> + +<h2> +Getting Started with LLVM +</h2> + +<dl compact> + <dt> + For license information: + <dd> + llvm/LICENSE.txt + + <dt> + Installing and compiling LLVM: + <dd> + llvm/docs/GettingStarted.html + + <dt> + Learn about features and limitations of this release: + <dd> + llvm/docs/ReleaseNotes.html + + <dt> + Learn how to write a pass within the LLVM system: + <dd> + llvm/docs/WritingAnLLVMPass.html + + <dt> + Learn how to start a new development project using LLVM, where your + <dd> + new source code can live anywhere (outside or inside the LLVM tree), + while using LLVM header files and libraries: + llvm/docs/Projects.html +</dl> + +<hr> + +<h2> +Getting Help with LLVM +</h2> + +<ol> + <li> + If you have questions or development problems not answered in the + documentation, send e-mail to llvmdev@cs.uiuc.edu. This mailing list is + monitored by all the people in the LLVM group at Illinois, and you should + expect prompt first responses. + </li> + + <li> + To report a bug, submit a bug report as described in the document: + http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html + </li> + + <li> + We now use Bugzilla to track bugs, so you can check the status of + previous bugs at: + <a href="http://llvm.cs.uiuc.edu/bugs/query.cgi"> + http://llvm.cs.uiuc.edu/bugs/query.cgi </a> + </li> +</ol> + +<hr> + +<h2> +LLVM Documentation +</h2> + +All the documents mentioned below except the design overview tech report +are included as part of the LLVM release (in llvm/docs/*): + +<h3> +LLVM Design Overview: +</h3> + +<dl compact> + <dt> + LLVM : A Compilation Framework for Lifelong Program Analysis + and Transformation: + <dd> + http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html + +</dl> + +<h3> +LLVM User Guides: +</h3> + +<dl compact> + <dt> + Download and Installation Instructions: + <dd> + llvm/docs/GettingStarted.html + + <dt> + LLVM Command Guide: + <dd> + llvm/docs/CommandGuide/CommandGuide.html + + <dt> + LLVM Assembly Language: + <dd> + llvm/docs/LangRef.html + + <dt> + LLVM Test Suite Guide: + <dd> + llvm/docs/TestingGuide.html +</dl> + +<h3> +LLVM Programming Documentation: +</h3> + +<dl compact> + <dt> + LLVM Programmers Manual: + <dd> + llvm/docs/ProgrammersManual.html + + <dt> + Writing an LLVM Pass: + <dd> + llvm/docs/WritingAnLLVMPass.html + + <dt> + Alias Analysis in LLVM: + <dd> + llvm/docs/AliasAnalysis.html + + <dt> + Command Line Library: + <dd> + llvm/docs/CommandLine.html + + <dt> + Coding Standards: + <dd> + llvm/docs/CodingStandards.html +</dl> + +<h3> +Other LLVM Resources: +</h3> + +<dl compact> + <dt> + Submitting a Bug: + <dd> + http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html + + <dt> + Open Projects: + <dd> + llvm/docs/OpenProjects.html + + <dt> + Creating a new LLVM Project: + <dd> + llvm/docs/Projects.html +</dl> + +<hr> + +<h2> +Mailing Lists +</h2> +There are three mailing lists for providing LLVM users with information: + +<ol> + <li> LLVM Announcements List:<br> + http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce + + <p> + 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. + </p> + + <li> LLVM Developers List:<br> + http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev + + <p> + 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 relatively low volume. + </p> + + <li> LLVM Commits List<br> + http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits + + <p> + 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. + </p> +</ol> +</body> +</html> + |