llvm-project/README.md

# The LLVM Compiler Infrastructure

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/llvm/llvm-project/badge)](https://securityscorecards.dev/viewer/?uri=github.com/llvm/llvm-project)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8273/badge)](https://www.bestpractices.dev/projects/8273)
[![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)

Welcome to the LLVM project!

This repository contains the source code for LLVM, a toolkit for the
construction of highly optimized compilers, optimizers, and run-time
environments.

The LLVM project has multiple components. The core of the project is
itself called "LLVM". This contains all of the tools, libraries, and header
files needed to process intermediate representations and convert them into
object files. Tools include an assembler, disassembler, bitcode analyzer, and
bitcode optimizer.

C-like languages use the [Clang](https://clang.llvm.org/) frontend. This
component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode
-- and from there into object files, using LLVM.

Other components include:
the [libc++ C++ standard library](https://libcxx.llvm.org),
the [LLD linker](https://lld.llvm.org), and more.

## Getting the Source Code and Building LLVM

Consult the
[Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm)
page for information on building and running LLVM.

For information on how to contribute to the LLVM project, please take a look at
the [Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.

## Getting in touch

Join the [LLVM Discourse forums](https://discourse.llvm.org/), [Discord
chat](https://discord.gg/xS7Z362),
[LLVM Office Hours](https://llvm.org/docs/GettingInvolved.html#office-hours) or
[Regular sync-ups](https://llvm.org/docs/GettingInvolved.html#online-sync-ups).

The LLVM project has adopted a [code of conduct](https://llvm.org/docs/CodeOfConduct.html) for
participants to all modes of communication within the project.
Update the project name in README.md Per llvm.org: "The name "LLVM" itself is not an acronym; it is the full name of the project." llvm-svn: 344766 2018-10-19 00:03:01 +00:00			`# The LLVM Compiler Infrastructure`
Add an svn project to contain the files that appear at the root of the monorepo. llvm-svn: 316185 2017-10-19 21:09:49 +00:00
Add Scorecard Action (#69933) Closes #69736 2023-11-01 15:08:26 -03:00			`[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/llvm/llvm-project/badge)](https://securityscorecards.dev/viewer/?uri=github.com/llvm/llvm-project)`
Add OpenSSF Best Practice Badge (#77398) This tracks our progress implementing the OpenSSF Best Practices for LLVM. 2024-01-13 07:43:11 -08:00			`[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8273/badge)](https://www.bestpractices.dev/projects/8273)`
[libc++][CI] Moves CI badge to main README. (#77247) The current CI badge is currently in libc++ documentation. This does not seem the right place: - The typical location on GitHub is on the main README. - The documentation is shipped as part of the release: - This link does not work in off-line mode. Currently our documentation works in off-line mode. - The status in the release documentation does not reflect the status of the shipped library. So users looking at it may see a red status and get confused. This moves the badge to the README. 2024-01-09 19:12:42 +01:00			`[![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)`
Add Scorecard Action (#69933) Closes #69736 2023-11-01 15:08:26 -03:00
Add beginning of LLVM's GettingStarted to GitHub readme Reviewed and approved by chandlerc. As GitHub is the canonical LLVM repository now, embrace GitHub's way of displaying basic build instructions in the top-level readme.md. 2019-10-23 18:03:37 -07:00			`Welcome to the LLVM project!`

[docs] Update README and GettingStarted Funnel fetching and building LLVM instructions into GettingStarted. Modernize the build steps a little. Remove comments saying CMAKE_BUILD_TYPE defaults to Debug as that's not true anymore (must explicitly pass it). Reviewed By: MaskRay, hans Differential Revision: https://reviews.llvm.org/D145413 2023-03-06 11:45:23 -08:00			`This repository contains the source code for LLVM, a toolkit for the`
			`construction of highly optimized compilers, optimizers, and run-time`
			`environments.`

Add beginning of LLVM's GettingStarted to GitHub readme Reviewed and approved by chandlerc. As GitHub is the canonical LLVM repository now, embrace GitHub's way of displaying basic build instructions in the top-level readme.md. 2019-10-23 18:03:37 -07:00			`The LLVM project has multiple components. The core of the project is`
			`itself called "LLVM". This contains all of the tools, libraries, and header`
Fix grammar in README.md 2021-05-12 08:48:50 -07:00			`files needed to process intermediate representations and convert them into`
Fixed minor documentation issues Fixed whitespace and punctuation issues, added a name to a link, and fixed a typo. 2022-03-31 07:35:40 -04:00			`object files. Tools include an assembler, disassembler, bitcode analyzer, and`
[docs] Update README and GettingStarted Funnel fetching and building LLVM instructions into GettingStarted. Modernize the build steps a little. Remove comments saying CMAKE_BUILD_TYPE defaults to Debug as that's not true anymore (must explicitly pass it). Reviewed By: MaskRay, hans Differential Revision: https://reviews.llvm.org/D145413 2023-03-06 11:45:23 -08:00			`bitcode optimizer.`
Add beginning of LLVM's GettingStarted to GitHub readme Reviewed and approved by chandlerc. As GitHub is the canonical LLVM repository now, embrace GitHub's way of displaying basic build instructions in the top-level readme.md. 2019-10-23 18:03:37 -07:00
[docs] README: Switch link to clang.llvm.org to use HTTPS. 2024-02-17 12:28:31 +01:00			`C-like languages use the [Clang](https://clang.llvm.org/) frontend. This`
Add missing hyphens 2020-04-06 23:36:49 -07:00			`component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode`
Add beginning of LLVM's GettingStarted to GitHub readme Reviewed and approved by chandlerc. As GitHub is the canonical LLVM repository now, embrace GitHub's way of displaying basic build instructions in the top-level readme.md. 2019-10-23 18:03:37 -07:00			`-- and from there into object files, using LLVM.`

			`Other components include:`
			`the [libc++ C++ standard library](https://libcxx.llvm.org),`
			`the [LLD linker](https://lld.llvm.org), and more.`

[docs] Update README and GettingStarted Funnel fetching and building LLVM instructions into GettingStarted. Modernize the build steps a little. Remove comments saying CMAKE_BUILD_TYPE defaults to Debug as that's not true anymore (must explicitly pass it). Reviewed By: MaskRay, hans Differential Revision: https://reviews.llvm.org/D145413 2023-03-06 11:45:23 -08:00			`## Getting the Source Code and Building LLVM`
Add beginning of LLVM's GettingStarted to GitHub readme Reviewed and approved by chandlerc. As GitHub is the canonical LLVM repository now, embrace GitHub's way of displaying basic build instructions in the top-level readme.md. 2019-10-23 18:03:37 -07:00
			`Consult the`
[docs] Update README and GettingStarted Funnel fetching and building LLVM instructions into GettingStarted. Modernize the build steps a little. Remove comments saying CMAKE_BUILD_TYPE defaults to Debug as that's not true anymore (must explicitly pass it). Reviewed By: MaskRay, hans Differential Revision: https://reviews.llvm.org/D145413 2023-03-06 11:45:23 -08:00			`[Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm)`
			`page for information on building and running LLVM.`

			`For information on how to contribute to the LLVM project, please take a look at`
			`the [Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.`
README: Point to the discourse & discord forums Differential Revision: https://reviews.llvm.org/D119279 2022-02-08 21:54:32 +01:00
			`## Getting in touch`

[docs] Update README and GettingStarted Funnel fetching and building LLVM instructions into GettingStarted. Modernize the build steps a little. Remove comments saying CMAKE_BUILD_TYPE defaults to Debug as that's not true anymore (must explicitly pass it). Reviewed By: MaskRay, hans Differential Revision: https://reviews.llvm.org/D145413 2023-03-06 11:45:23 -08:00			`Join the [LLVM Discourse forums](https://discourse.llvm.org/), [Discord`
[docs] Improve README: point to office hours and online sync-ups (#69323) The main README.md should probably be kept pretty short and be used to point new-comers to the most essential ways to get started on or get involved with LLVM. Therefore, this patch removes a pointer to IRC (not used very much these days), and does add pointers to office hours and online sync-ups. 2023-10-27 09:45:10 +02:00			`chat](https://discord.gg/xS7Z362),`
			`[LLVM Office Hours](https://llvm.org/docs/GettingInvolved.html#office-hours) or`
			`[Regular sync-ups](https://llvm.org/docs/GettingInvolved.html#online-sync-ups).`
README: Point to the discourse & discord forums Differential Revision: https://reviews.llvm.org/D119279 2022-02-08 21:54:32 +01:00
			`The LLVM project has adopted a [code of conduct](https://llvm.org/docs/CodeOfConduct.html) for`
			`participants to all modes of communication within the project.`