rust/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

78 lines
3.1 KiB
Markdown
Raw Normal View History

2024-03-26 12:30:46 +00:00
<div align="center">
<picture>
<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">
<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">
2024-03-26 12:30:46 +00:00
<img alt="The Rust Programming Language: A language empowering everyone to build reliable and efficient software"
src="https://raw.githubusercontent.com/rust-lang/www.rust-lang.org/master/static/images/rust-social-wide-light.svg"
2024-03-26 12:30:46 +00:00
width="50%">
</picture>
[Website][Rust] | [Getting started] | [Learn] | [Documentation] | [Contributing]
</div>
This is the main source code repository for [Rust]. It contains the compiler,
standard library, and documentation.
2022-12-29 05:47:09 +00:00
[Rust]: https://www.rust-lang.org/
2024-03-26 12:30:46 +00:00
[Getting Started]: https://www.rust-lang.org/learn/get-started
[Learn]: https://www.rust-lang.org/learn
[Documentation]: https://www.rust-lang.org/learn#learn-use
[Contributing]: CONTRIBUTING.md
## 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
2017-06-09 05:37:22 +00:00
Read ["Installation"] from [The Book].
2018-12-10 22:28:55 +00:00
["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
[The Book]: https://doc.rust-lang.org/book/index.html
2024-01-15 21:57:29 +00:00
## Installing from Source
2024-01-15 21:57:29 +00:00
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).
2020-09-02 00:48:15 +00:00
## License
2022-12-29 05:47:09 +00: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.
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
2022-12-29 05:47:09 +00:00
trademarks and logos (the "Rust Trademarks").
2022-12-29 05:47:09 +00:00
If you want to use these names or brands, please read the
[media guide][media-guide].
2019-04-12 14:14:21 +00:00
Third-party logos may be subject to third-party copyrights and trademarks. See
[Licenses][policies-licenses] for details.
2021-05-20 10:11:01 +00:00
[rust-foundation]: https://foundation.rust-lang.org/
2022-12-29 05:47:09 +00:00
[media-guide]: https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/
2019-04-12 14:14:21 +00:00
[policies-licenses]: https://www.rust-lang.org/policies/licenses