README.md
1<div align="center">
2 <picture>
3 <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/rust-lang/www.rust-lang.org/master/static/images/rust-social-wide-dark.svg">
4 <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/rust-lang/www.rust-lang.org/master/static/images/rust-social-wide-light.svg">
5 <img alt="The Rust Programming Language: A language empowering everyone to build reliable and efficient software"
6 src="https://raw.githubusercontent.com/rust-lang/www.rust-lang.org/master/static/images/rust-social-wide-light.svg"
7 width="50%">
8 </picture>
9
10[Website][Rust] | [Getting started] | [Learn] | [Documentation] | [Contributing]
11</div>
12
13This is the main source code repository for [Rust]. It contains the compiler,
14standard library, and documentation.
15
16[Rust]: https://www.rust-lang.org/
17[Getting Started]: https://www.rust-lang.org/learn/get-started
18[Learn]: https://www.rust-lang.org/learn
19[Documentation]: https://www.rust-lang.org/learn#learn-use
20[Contributing]: CONTRIBUTING.md
21
22## Why Rust?
23
24- **Performance:** Fast and memory-efficient, suitable for critical services, embedded devices, and easily integrate with other languages.
25
26- **Reliability:** Our rich type system and ownership model ensure memory and thread safety, reducing bugs at compile-time.
27
28- **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]).
29
30[Cargo]: https://github.com/rust-lang/cargo
31[rustfmt]: https://github.com/rust-lang/rustfmt
32[Clippy]: https://github.com/rust-lang/rust-clippy
33[rust-analyzer]: https://github.com/rust-lang/rust-analyzer
34
35## Quick Start
36
37Read ["Installation"] from [The Book].
38
39["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
40[The Book]: https://doc.rust-lang.org/book/index.html
41
42## Installing from Source
43
44If you really want to install from source (though this is not recommended), see
45[INSTALL.md](INSTALL.md).
46
47## Getting Help
48
49See https://www.rust-lang.org/community for a list of chat platforms and forums.
50
51## Contributing
52
53See [CONTRIBUTING.md](CONTRIBUTING.md).
54
55## License
56
57Rust is primarily distributed under the terms of both the MIT license and the
58Apache License (Version 2.0), with portions covered by various BSD-like
59licenses.
60
61See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
62[COPYRIGHT](COPYRIGHT) for details.
63
64## Trademark
65
66[The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
67trademarks and logos (the "Rust Trademarks").
68
69If you want to use these names or brands, please read the
70[media guide][media-guide].
71
72Third-party logos may be subject to third-party copyrights and trademarks. See
73[Licenses][policies-licenses] for details.
74
75[rust-foundation]: https://foundation.rust-lang.org/
76[media-guide]: https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/
77[policies-licenses]: https://www.rust-lang.org/policies/licenses
78
