]> git.proxmox.com Git - rustc.git/blame - README.md
bump version to 1.80.1+dfsg1-1~bpo12+pve1
[rustc.git] / README.md
CommitLineData
e8be2606
FG
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>
9ffffee4 12
3157f602 13This is the main source code repository for [Rust]. It contains the compiler,
3dfed10e 14standard library, and documentation.
62682a34 15
9c376795 16[Rust]: https://www.rust-lang.org/
e8be2606
FG
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?
223e47cc 23
e8be2606 24- **Performance:** Fast and memory-efficient, suitable for critical services, embedded devices, and easily integrate with other languages.
f035d41b 25
e8be2606 26- **Reliability:** Our rich type system and ownership model ensure memory and thread safety, reducing bugs at compile-time.
ed00b5ec 27
e8be2606 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]).
ed00b5ec 29
e8be2606
FG
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
ed00b5ec 34
1a4d82fc 35## Quick Start
223e47cc 36
041b39d2 37Read ["Installation"] from [The Book].
223e47cc 38
0731742a 39["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
e9174d1e 40[The Book]: https://doc.rust-lang.org/book/index.html
223e47cc 41
9fa01778 42## Installing from Source
223e47cc 43
c0240ec0
FG
44If you really want to install from source (though this is not recommended), see
45[INSTALL.md](INSTALL.md).
1a4d82fc 46
c34b1796 47## Getting Help
1a4d82fc 48
9c376795 49See https://www.rust-lang.org/community for a list of chat platforms and forums.
85aaf69f
SL
50
51## Contributing
52
9c376795 53See [CONTRIBUTING.md](CONTRIBUTING.md).
1b1a35ee 54
223e47cc
LB
55## License
56
9c376795
FG
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.
223e47cc 60
3157f602
XL
61See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
62[COPYRIGHT](COPYRIGHT) for details.
48663c56
XL
63
64## Trademark
48663c56 65
136023e0 66[The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
9c376795 67trademarks and logos (the "Rust Trademarks").
48663c56 68
9c376795
FG
69If you want to use these names or brands, please read the
70[media guide][media-guide].
48663c56
XL
71
72Third-party logos may be subject to third-party copyrights and trademarks. See
73[Licenses][policies-licenses] for details.
74
136023e0 75[rust-foundation]: https://foundation.rust-lang.org/
9c376795 76[media-guide]: https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/
48663c56 77[policies-licenses]: https://www.rust-lang.org/policies/licenses