John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 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: |
John Criswell | ddf31f7 | 2003-10-17 21:10:57 +0000 | [diff] [blame] | 16 | |
John Criswell | 6a513d8 | 2003-10-13 21:09:04 +0000 | [diff] [blame] | 17 | LLVM Home Page: |
| 18 | http://llvm.cs.uiuc.edu |
| 19 | |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 20 | License Information: |
| 21 | llvm/LICENSE.txt |
| 22 | |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 23 | Release Notes: |
| 24 | llvm/docs/ReleaseNotes.html |
| 25 | |
John Criswell | ddf31f7 | 2003-10-17 21:10:57 +0000 | [diff] [blame] | 26 | LLVM Design: |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 27 | |
John Criswell | ddf31f7 | 2003-10-17 21:10:57 +0000 | [diff] [blame] | 28 | The LLVM Instruction Set and Compilation Strategy: |
| 29 | http://llvm.cs.uiuc.edu/pubs/2002-08-09-LLVMCompilationStrategy.html |
| 30 | |
| 31 | LLVM User Guides: |
| 32 | |
| 33 | Download and Installation Instructions: |
| 34 | llvm/docs/GettingStarted.html |
| 35 | |
| 36 | LLVM Command Guide: |
| 37 | llvm/docs/CommandGuide/CommandGuide.html |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 38 | |
| 39 | LLVM Assembly Language: |
| 40 | llvm/docs/LangRef.html |
| 41 | |
John Criswell | ddf31f7 | 2003-10-17 21:10:57 +0000 | [diff] [blame] | 42 | LLVM Test Suite Guide: |
| 43 | llvm/docs/TestingGuide.html |
| 44 | |
| 45 | LLVM Programming Documentation: |
| 46 | |
| 47 | LLVM Programmers Manual: |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 48 | llvm/docs/ProgrammersManual.html |
| 49 | |
John Criswell | ddf31f7 | 2003-10-17 21:10:57 +0000 | [diff] [blame] | 50 | Writing an LLVM Pass: |
| 51 | llvm/docs/WritingAnLLVMPass.html |
| 52 | |
| 53 | Alias Analysis in LLVM: |
| 54 | llvm/docs/AliasAnalysis.html |
| 55 | |
| 56 | Command Line Library: |
| 57 | llvm/docs/CommandLine.html |
| 58 | |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 59 | Coding Standards: |
| 60 | llvm/docs/CodingStandards.html |
| 61 | |
| 62 | LLVM Community: |
John Criswell | ddf31f7 | 2003-10-17 21:10:57 +0000 | [diff] [blame] | 63 | |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 64 | Submitting a Bug: |
John Criswell | ddf31f7 | 2003-10-17 21:10:57 +0000 | [diff] [blame] | 65 | http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html |
| 66 | |
| 67 | Open Projects: |
| 68 | llvm/docs/OpenProjects.html |
| 69 | |
| 70 | Creating a new LLVM Project: |
| 71 | llvm/docs/Projects.html |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 72 | |
| 73 | Mailing Lists: |
John Criswell | 6a513d8 | 2003-10-13 21:09:04 +0000 | [diff] [blame] | 74 | There are several mailing lists providing LLVM users with |
| 75 | information: |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 76 | |
| 77 | o LLVM Announcements List: |
| 78 | http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce |
| 79 | |
John Criswell | 6a513d8 | 2003-10-13 21:09:04 +0000 | [diff] [blame] | 80 | This is a low volume list that provides |
| 81 | important announcements regarding LLVM. It is |
| 82 | primarily intended to announce new releases, |
| 83 | major updates to the software, etc. This list |
| 84 | is highly recommended for anyone that uses LLVM. |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 85 | |
| 86 | |
| 87 | o LLVM Developers List: |
| 88 | http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev |
| 89 | |
John Criswell | 6a513d8 | 2003-10-13 21:09:04 +0000 | [diff] [blame] | 90 | This list is for people who want to be included |
| 91 | in technical discussions of LLVM. People post |
| 92 | to this list when they have questions about |
| 93 | writing code for or using the LLVM tools. It |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 94 | is low volume. |
| 95 | |
| 96 | o LLVM Commits List |
| 97 | http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits |
| 98 | |
John Criswell | 6a513d8 | 2003-10-13 21:09:04 +0000 | [diff] [blame] | 99 | This list contains all commit messages that are |
| 100 | made when LLVM developers commit code changes |
| 101 | to the CVS archive. It is useful for those who |
| 102 | want to stay on the bleeding edge of LLVM |
John Criswell | 85bf334 | 2003-10-13 15:59:28 +0000 | [diff] [blame] | 103 | development. |
| 104 | |
| 105 | This list is very high volume. |
| 106 | |