82 lines
2.7 KiB
Markdown
82 lines
2.7 KiB
Markdown
# The Rust Programming Language
|
|
|
|
[](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
|