llvm.org GIT mirror llvm / c146250
HTML version of README.txt git-svn-id: https://llvm.org/svn/llvm-project/llvm/branches/release_1@9468 91177308-0d34-0410-b5e6-96231b3b80d8 John Criswell 15 years ago
1 changed file(s) with 242 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
0
1 </span> </span> </td> </tr><tr><td class=linenos></td><td class=linenos><a href="#0-R-2">2</a></td> <td class="add"> <span id="0-R-2"><a name="0-R-2"></a><span class=line>The LLVM Compiler Infrastructure </span> </span> </td> </tr><tr><td class=linenos></td><td class=linenos><a href="#0-R-3">3</a></td> <td class="add"> <span id="0-R-3"><a name="0-R-3"></a><span class=line>
4
5
6
7
8

9 The LLVM Compiler Infrastructure
10
11 http://llvm.cs.uiuc.edu
12
13
14
15
16
17

18 Welcome to LLVM!
19
20 This file is intended to do four things:
21
22
  • 23 help you get started using LLVM;
    24
    25
    26
  • 27 tell you how to get questions about LLVM answered;
    28
    29
    30
  • 31 tell you where to find documentation for different kinds of questions; and
    32
    33
    34
  • 35 tell you about three LLVM-related mailing lists.
    36
    37
    38
    39
    40
    41
    42

    43 Getting Started with LLVM
    44
    45
    46
    47
    48 For license information:
    49
    50 llvm/LICENSE.txt
    51
    52
    53 Installing and compiling LLVM:
    54
    55 llvm/docs/GettingStarted.html
    56
    57
    58 Learn about features and limitations of this release:
    59
    60 llvm/docs/ReleaseNotes.html
    61
    62
    63 Learn how to write a pass within the LLVM system:
    64
    65 llvm/docs/WritingAnLLVMPass.html
    66
    67
    68 Learn how to start a new development project using LLVM, where your
    69
    70 new source code can live anywhere (outside or inside the LLVM tree),
    71 while using LLVM header files and libraries:
    72 llvm/docs/Projects.html
    73
    74
    75
    76
    77

    78 Getting Help with LLVM
    79
    80
    81
    82
  • 83 If you have questions or development problems not answered in the
    84 documentation, send e-mail to llvmdev@cs.uiuc.edu. This mailing list is
    85 monitored by all the people in the LLVM group at Illinois, and you should
    86 expect prompt first responses.
    87
    88
    89
  • 90 To report a bug, submit a bug report as described in the document:
    91 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
    92
    93
    94
  • 95 We now use Bugzilla to track bugs, so you can check the status of
    96 previous bugs at:
    97
    98 http://llvm.cs.uiuc.edu/bugs/query.cgi
    99
    100
    101
    102
    103
    104

    105 LLVM Documentation
    106
    107
    108 All the documents mentioned below except the design overview tech report
    109 are included as part of the LLVM release (in llvm/docs/*):
    110
    111

    112 LLVM Design Overview:
    113
    114
    115
    116
    117 LLVM : A Compilation Framework for Lifelong Program Analysis
    118 and Transformation:
    119
    120 http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html
    121
    122
    123
    124

    125 LLVM User Guides:
    126
    127
    128
    129
    130 Download and Installation Instructions:
    131
    132 llvm/docs/GettingStarted.html
    133
    134
    135 LLVM Command Guide:
    136
    137 llvm/docs/CommandGuide/CommandGuide.html
    138
    139
    140 LLVM Assembly Language:
    141
    142 llvm/docs/LangRef.html
    143
    144
    145 LLVM Test Suite Guide:
    146
    147 llvm/docs/TestingGuide.html
    148
    149
    150

    151 LLVM Programming Documentation:
    152
    153
    154
    155
    156 LLVM Programmers Manual:
    157
    158 llvm/docs/ProgrammersManual.html
    159
    160
    161 Writing an LLVM Pass:
    162
    163 llvm/docs/WritingAnLLVMPass.html
    164
    165
    166 Alias Analysis in LLVM:
    167
    168 llvm/docs/AliasAnalysis.html
    169
    170
    171 Command Line Library:
    172
    173 llvm/docs/CommandLine.html
    174
    175
    176 Coding Standards:
    177
    178 llvm/docs/CodingStandards.html
    179
    180
    181

    182 Other LLVM Resources:
    183
    184
    185
    186
    187 Submitting a Bug:
    188
    189 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html
    190
    191
    192 Open Projects:
    193
    194 llvm/docs/OpenProjects.html
    195
    196
    197 Creating a new LLVM Project:
    198
    199 llvm/docs/Projects.html
    200
    201
    202
    203
    204

    205 Mailing Lists
    206
    207 There are three mailing lists for providing LLVM users with information:
    208
    209
    210
  • LLVM Announcements List:
  • 211 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce
    212
    213

    214 This is a low volume list that provides important announcements regarding
    215 LLVM. It is primarily intended to announce new releases, major updates to
    216 the software, etc. This list is highly recommended for anyone that uses
    217 LLVM.
    218

    219
    220
  • LLVM Developers List:
  • 221 http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev
    222
    223

    224 This list is for people who want to be included in technical discussions
    225 of LLVM. People post to this list when they have questions about writing
    226 code for or using the LLVM tools. It is relatively low volume.
    227

    228
    229
  • LLVM Commits List
  • 230 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits
    231
    232

    233 This list contains all commit messages that are made when LLVM developers
    234 commit code changes to the CVS archive. It is useful for those who want to
    235 stay on the bleeding edge of LLVM development. This list is very high
    236 volume.
    237

    238
    239
    240
    241