|
1 | 1 | # ClangIR (CIR)
|
2 | 2 |
|
3 |
| -For more information see https://clangir.org. The rest of this document |
4 |
| -fallbacks to llvm-project's default `README.md`. |
5 |
| - |
6 |
| ---- |
7 |
| - |
8 |
| -# The LLVM Compiler Infrastructure |
9 |
| - |
10 |
| -[](https://securityscorecards.dev/viewer/?uri=github.com/llvm/llvm-project) |
11 |
| -[](https://www.bestpractices.dev/projects/8273) |
12 |
| -[](https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml?query=event%3Aschedule) |
13 |
| - |
14 |
| -Welcome to the LLVM project! |
15 |
| - |
16 |
| -This repository contains the source code for LLVM, a toolkit for the |
17 |
| -construction of highly optimized compilers, optimizers, and run-time |
18 |
| -environments. |
19 |
| - |
20 |
| -The LLVM project has multiple components. The core of the project is |
21 |
| -itself called "LLVM". This contains all of the tools, libraries, and header |
22 |
| -files needed to process intermediate representations and convert them into |
23 |
| -object files. Tools include an assembler, disassembler, bitcode analyzer, and |
24 |
| -bitcode optimizer. |
25 |
| - |
26 |
| -C-like languages use the [Clang](https://clang.llvm.org/) frontend. This |
27 |
| -component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode |
28 |
| --- and from there into object files, using LLVM. |
29 |
| - |
30 |
| -Other components include: |
31 |
| -the [libc++ C++ standard library](https://libcxx.llvm.org), |
32 |
| -the [LLD linker](https://lld.llvm.org), and more. |
33 |
| - |
34 |
| -## Getting the Source Code and Building LLVM |
35 |
| - |
36 |
| -Consult the |
37 |
| -[Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm) |
38 |
| -page for information on building and running LLVM. |
39 |
| - |
40 |
| -For information on how to contribute to the LLVM project, please take a look at |
41 |
| -the [Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide. |
42 |
| - |
43 |
| -## Getting in touch |
44 |
| - |
45 |
| -Join the [LLVM Discourse forums](https://discourse.llvm.org/), [Discord |
46 |
| -chat](https://discord.gg/xS7Z362), |
47 |
| -[LLVM Office Hours](https://llvm.org/docs/GettingInvolved.html#office-hours) or |
48 |
| -[Regular sync-ups](https://llvm.org/docs/GettingInvolved.html#online-sync-ups). |
49 |
| - |
50 |
| -The LLVM project has adopted a [code of conduct](https://llvm.org/docs/CodeOfConduct.html) for |
51 |
| -participants to all modes of communication within the project. |
52 |
| - |
53 |
| -### License |
54 |
| - |
55 |
| -ClangIR is based off https://github.com/llvm/llvm-project and uses the same |
56 |
| -license. This ClangIR project is under the Apache License v2.0 with LLVM |
57 |
| -Exceptions. Please see the `LICENSE.TXT` for the full details. |
58 |
| - |
59 |
| -## Contributing |
60 |
| - |
61 |
| -Check our [contributing guide](CONTRIBUTING.md) to learn about how to |
62 |
| -contribute to the project. |
63 |
| - |
64 |
| -## Code Of Confuct |
65 |
| - |
66 |
| -Check our [Code Of Conduct](CODE_OF_CONDUCT.md) to learn more about our |
67 |
| -contributor standards and expectations. |
68 |
| - |
| 3 | +Check https://clangir.org for general information, build instructions and documentation. |
0 commit comments