annotate README.md @ 256:7d9b19ec7a62

cbclang output is still wrong
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Fri, 18 Aug 2023 18:48:47 +0900
parents 731cecd08f47
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 # The LLVM Compiler Infrastructure
anatofuz
parents:
diff changeset
2
252
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
3 Welcome to the LLVM project!
150
anatofuz
parents:
diff changeset
4
252
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
5 This repository contains the source code for LLVM, a toolkit for the
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
6 construction of highly optimized compilers, optimizers, and run-time
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
7 environments.
150
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 The LLVM project has multiple components. The core of the project is
anatofuz
parents:
diff changeset
10 itself called "LLVM". This contains all of the tools, libraries, and header
207
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
11 files needed to process intermediate representations and convert them into
236
c4bab56944e8 LLVM 16
kono
parents: 223
diff changeset
12 object files. Tools include an assembler, disassembler, bitcode analyzer, and
252
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
13 bitcode optimizer.
150
anatofuz
parents:
diff changeset
14
236
c4bab56944e8 LLVM 16
kono
parents: 223
diff changeset
15 C-like languages use the [Clang](http://clang.llvm.org/) frontend. This
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
16 component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode
150
anatofuz
parents:
diff changeset
17 -- and from there into object files, using LLVM.
anatofuz
parents:
diff changeset
18
anatofuz
parents:
diff changeset
19 Other components include:
anatofuz
parents:
diff changeset
20 the [libc++ C++ standard library](https://libcxx.llvm.org),
anatofuz
parents:
diff changeset
21 the [LLD linker](https://lld.llvm.org), and more.
anatofuz
parents:
diff changeset
22
252
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
23 ## Getting the Source Code and Building LLVM
150
anatofuz
parents:
diff changeset
24
anatofuz
parents:
diff changeset
25 Consult the
252
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
26 [Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm)
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
27 page for information on building and running LLVM.
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
28
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
29 For information on how to contribute to the LLVM project, please take a look at
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
30 the [Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.
236
c4bab56944e8 LLVM 16
kono
parents: 223
diff changeset
31
c4bab56944e8 LLVM 16
kono
parents: 223
diff changeset
32 ## Getting in touch
c4bab56944e8 LLVM 16
kono
parents: 223
diff changeset
33
252
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
34 Join the [LLVM Discourse forums](https://discourse.llvm.org/), [Discord
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
35 chat](https://discord.gg/xS7Z362), or #llvm IRC channel on
1f2b6ac9f198 LLVM16-1
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 236
diff changeset
36 [OFTC](https://oftc.net/).
236
c4bab56944e8 LLVM 16
kono
parents: 223
diff changeset
37
c4bab56944e8 LLVM 16
kono
parents: 223
diff changeset
38 The LLVM project has adopted a [code of conduct](https://llvm.org/docs/CodeOfConduct.html) for
c4bab56944e8 LLVM 16
kono
parents: 223
diff changeset
39 participants to all modes of communication within the project.