rust/README.md

# The Rust Programming Language

[![Rust Community](https://img.shields.io/badge/Rust_Community%20-Join_us-brightgreen?style=plastic&logo=rust)](https://www.rust-lang.org/community)

This is the main source code repository for [Rust]. It contains the compiler,
standard library, and documentation.

[Rust]: https://www.rust-lang.org/

**Note: this README is for _users_ rather than _contributors_.**
If you wish to _contribute_ to the compiler, you should read
[CONTRIBUTING.md](CONTRIBUTING.md) instead.

<details>
<summary>Table of Contents</summary>

- [Quick Start](#quick-start)
- [Installing from Source](#installing-from-source)
- [Getting Help](#getting-help)
- [Contributing](#contributing)
- [License](#license)
- [Trademark](#trademark)

</details>

## Why Rust?

- **Performance:** Fast and memory-efficient, suitable for critical services, embedded devices, and easily integrate with other languages.

- **Reliability:** Our rich type system and ownership model ensure memory and thread safety, reducing bugs at compile-time.

- **Productivity:** Comprehensive documentation, a compiler committed to providing great diagnostics, and advanced tooling including package manager and build tool ([Cargo]), auto-formatter ([rustfmt]), linter ([Clippy]) and editor support ([rust-analyzer]).

[Cargo]: https://github.com/rust-lang/cargo
[rustfmt]: https://github.com/rust-lang/rustfmt
[Clippy]: https://github.com/rust-lang/rust-clippy
[rust-analyzer]: https://github.com/rust-lang/rust-analyzer

## Quick Start

Read ["Installation"] from [The Book].

["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
[The Book]: https://doc.rust-lang.org/book/index.html

## Installing from Source

If you really want to install from source (though this is not recommended), see
[INSTALL.md](INSTALL.md).

## Getting Help

See https://www.rust-lang.org/community for a list of chat platforms and forums.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

Rust is primarily distributed under the terms of both the MIT license and the
Apache License (Version 2.0), with portions covered by various BSD-like
licenses.

See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
[COPYRIGHT](COPYRIGHT) for details.

## Trademark

[The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
trademarks and logos (the "Rust Trademarks").

If you want to use these names or brands, please read the
[media guide][media-guide].

Third-party logos may be subject to third-party copyrights and trademarks. See
[Licenses][policies-licenses] for details.

[rust-foundation]: https://foundation.rust-lang.org/
[media-guide]: https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/
[policies-licenses]: https://www.rust-lang.org/policies/licenses
Bring back a top level heading 2020-12-23 13:17:34 -06:00			`# The Rust Programming Language`

Bages for easy access links to Rust community 2023-02-26 21:20:09 -06:00			`[![Rust Community](https://img.shields.io/badge/Rust_Community%20-Join_us-brightgreen?style=plastic&logo=rust)](https://www.rust-lang.org/community)`

Instructions on how to build Rust with rustbuild This is a much simpler option for those on Windows who use msvc. Signed-off-by: Peter Atashian <retep998@gmail.com> 2016-06-27 12:51:27 -05:00			`This is the main source code repository for [Rust]. It contains the compiler,`
older toolchains not valid any more with the change to llvm 10 the parameter LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN do not do any thing as min and soft error is the same. see https://github.com/rust-lang/llvm-project/blob/86b120e6f302d39cd6973b6391fb299d7bc22122/llvm/cmake/modules/CheckCompilerVersion.cmake 2020-07-19 09:53:37 -05:00			`standard library, and documentation.`
Update README Tries to make the introductory portion of the README flow better. 2015-05-15 00:43:40 -05:00
Improve Markdown styling in README 2022-12-28 23:47:09 -06:00			`[Rust]: https://www.rust-lang.org/`
README: improve description of Rust 2015-06-18 16:48:51 -05:00
Update README.md 2022-12-24 09:48:35 -06:00			`Note: this README is for _users_ rather than _contributors_.`
Improve Markdown styling in README 2022-12-28 23:47:09 -06:00			`If you wish to _contribute_ to the compiler, you should read`
			`[CONTRIBUTING.md](CONTRIBUTING.md) instead.`
move contributing.md to rustc-dev-guide and point at getting started 2020-06-17 14:25:00 -05:00
Updated README with expandable table of content. 2023-10-19 15:32:11 -05:00			`<details>`
Capitalize ToC in README.md 2023-11-29 23:03:31 -06:00			`<summary>Table of Contents</summary>`
Updated README with expandable table of content. 2023-10-19 15:32:11 -05:00
			`- [Quick Start](#quick-start)`
Update Readme 2024-01-15 15:57:29 -06:00			`- [Installing from Source](#installing-from-source)`
Updated README with expandable table of content. 2023-10-19 15:32:11 -05:00			`- [Getting Help](#getting-help)`
			`- [Contributing](#contributing)`
			`- [License](#license)`
			`- [Trademark](#trademark)`

			`</details>`

Add Why Rust? section to the README.md and mention our tools 2024-04-03 00:59:15 -05:00			`## Why Rust?`

			`- Performance: Fast and memory-efficient, suitable for critical services, embedded devices, and easily integrate with other languages.`

			`- Reliability: Our rich type system and ownership model ensure memory and thread safety, reducing bugs at compile-time.`

			`- Productivity: Comprehensive documentation, a compiler committed to providing great diagnostics, and advanced tooling including package manager and build tool ([Cargo]), auto-formatter ([rustfmt]), linter ([Clippy]) and editor support ([rust-analyzer]).`

			`[Cargo]: https://github.com/rust-lang/cargo`
			`[rustfmt]: https://github.com/rust-lang/rustfmt`
			`[Clippy]: https://github.com/rust-lang/rust-clippy`
			`[rust-analyzer]: https://github.com/rust-lang/rust-analyzer`

Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-18 18:27:43 -05:00			`## Quick Start`
Merge README.txt and INSTALL.txt into README.md 2012-07-10 00:13:48 -05:00
Update TRPL link in README.md 2017-06-09 00:37:22 -05:00			`Read ["Installation"] from [The Book].`
Add an INSTALL.txt and make it part of the source distribution 2012-01-23 15:53:12 -06:00
fix install broken link 2018-12-10 16:28:55 -06:00			`["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html`
Use https URLs to refer to rust-lang.org where appropriate. Also fixes a few outdated links. 2015-08-09 16:15:05 -05:00			`[The Book]: https://doc.rust-lang.org/book/index.html`
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-18 18:27:43 -05:00
Update Readme 2024-01-15 15:57:29 -06:00			`## Installing from Source`
Reorganize README to make it more clear. This also adds a note about required memory usage and instructions for building from Git. 2013-07-18 18:27:43 -05:00
Update Readme 2024-01-15 15:57:29 -06:00			`If you really want to install from source (though this is not recommended), see`
			`[INSTALL.md](INSTALL.md).`
Add an INSTALL.txt and make it part of the source distribution 2012-01-23 15:53:12 -06:00
Miscellaneous README changes - Various grammatical changes. - Use triple-backtick syntax and sh highlighting for code blocks. - Fix indentation of code block in step 2 of "Building on Windows". - Use title case for "Getting Help" subheading. 2015-02-21 16:46:06 -06:00			`## Getting Help`
Add links to forums in README.md, including discuss.rust-lang.org 2014-08-22 13:04:35 -05:00
Link to other resources instead of inlining their information The other places are more accurate and up-to-date. - Link to `std-dev-guide` in CONTRIBUTING.md Thom and Mara said the guide is in reasonably good shape, and it's tailored more closely to people working on the standard library. - Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme CONTRIBUTING.md has more information and also links the std-dev-guide. - Link to forge for the list of tested platforms; the one in the readme was hopelessly out of date. 2022-12-23 19:03:50 -06:00			`See https://www.rust-lang.org/community for a list of chat platforms and forums.`
CONTRIBUTING.md redux This redux of CONTRIBUTING.md adds in more information, including subsuming both compliment-bugreport.md and Note-development-policy in the wiki. I only glanced at the broad TOC of Note-development-policy, and did not use the text as the basis for the re-write. This will then address the last outstanding part of #5831. 2015-02-13 11:26:44 -06:00
			`## Contributing`

Link to other resources instead of inlining their information The other places are more accurate and up-to-date. - Link to `std-dev-guide` in CONTRIBUTING.md Thom and Mara said the guide is in reasonably good shape, and it's tailored more closely to people working on the standard library. - Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme CONTRIBUTING.md has more information and also links the std-dev-guide. - Link to forge for the list of tested platforms; the one in the readme was hopelessly out of date. 2022-12-23 19:03:50 -06:00			`See [CONTRIBUTING.md](CONTRIBUTING.md).`
Add missing link in README 2020-09-01 19:48:15 -05:00
Merge README.txt and INSTALL.txt into README.md 2012-07-10 00:13:48 -05:00			`## License`

Improve Markdown styling in README 2022-12-28 23:47:09 -06:00			`Rust is primarily distributed under the terms of both the MIT license and the`
			`Apache License (Version 2.0), with portions covered by various BSD-like`
			`licenses.`
Merge README.txt and INSTALL.txt into README.md 2012-07-10 00:13:48 -05:00
Instructions on how to build Rust with rustbuild This is a much simpler option for those on Windows who use msvc. Signed-off-by: Peter Atashian <retep998@gmail.com> 2016-06-27 12:51:27 -05:00			`See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and`
			`[COPYRIGHT](COPYRIGHT) for details.`
Add summary and reference to Rust trademark guide 2019-04-06 05:04:06 -05:00
			`## Trademark`

this section is just about trademarks, not governance 2021-05-25 21:51:13 -05:00			`[The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo`
Improve Markdown styling in README 2022-12-28 23:47:09 -06:00			`trademarks and logos (the "Rust Trademarks").`
Add summary and reference to Rust trademark guide 2019-04-06 05:04:06 -05:00
Improve Markdown styling in README 2022-12-28 23:47:09 -06:00			`If you want to use these names or brands, please read the`
			`[media guide][media-guide].`
Add summary and reference to Rust trademark guide 2019-04-06 05:04:06 -05:00
Add a link to the licenses page 2019-04-12 09:14:21 -05:00			`Third-party logos may be subject to third-party copyrights and trademarks. See`
			`[Licenses][policies-licenses] for details.`

the foundation owns rust trademarks 2021-05-20 05:11:01 -05:00			`[rust-foundation]: https://foundation.rust-lang.org/`
Improve Markdown styling in README 2022-12-28 23:47:09 -06:00			`[media-guide]: https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/`
Add a link to the licenses page 2019-04-12 09:14:21 -05:00			`[policies-licenses]: https://www.rust-lang.org/policies/licenses`