xref: /llvm-project/README.md (revision ca260e1b119b043195158098a9afda3967c6854b)
1# The LLVM Compiler Infrastructure
2
3[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/llvm/llvm-project/badge)](https://securityscorecards.dev/viewer/?uri=github.com/llvm/llvm-project)
4[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8273/badge)](https://www.bestpractices.dev/projects/8273)
5[![libc++](https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml/badge.svg?branch=main&event=schedule)](https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml?query=event%3Aschedule)
6
7Welcome to the LLVM project!
8
9This repository contains the source code for LLVM, a toolkit for the
10construction of highly optimized compilers, optimizers, and run-time
11environments.
12
13The LLVM project has multiple components. The core of the project is
14itself called "LLVM". This contains all of the tools, libraries, and header
15files needed to process intermediate representations and convert them into
16object files. Tools include an assembler, disassembler, bitcode analyzer, and
17bitcode optimizer.
18
19C-like languages use the [Clang](https://clang.llvm.org/) frontend. This
20component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode
21-- and from there into object files, using LLVM.
22
23Other components include:
24the [libc++ C++ standard library](https://libcxx.llvm.org),
25the [LLD linker](https://lld.llvm.org), and more.
26
27## Getting the Source Code and Building LLVM
28
29Consult the
30[Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm)
31page for information on building and running LLVM.
32
33For information on how to contribute to the LLVM project, please take a look at
34the [Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.
35
36## Getting in touch
37
38Join the [LLVM Discourse forums](https://discourse.llvm.org/), [Discord
39chat](https://discord.gg/xS7Z362),
40[LLVM Office Hours](https://llvm.org/docs/GettingInvolved.html#office-hours) or
41[Regular sync-ups](https://llvm.org/docs/GettingInvolved.html#online-sync-ups).
42
43The LLVM project has adopted a [code of conduct](https://llvm.org/docs/CodeOfConduct.html) for
44participants to all modes of communication within the project.
45