Urgau | 120c6b1 | 2024-03-26 12:30:46 | [diff] [blame] | 1 | <div align="center"> |
| 2 | <picture> |
Zander Milroy | ce4cc9d | 2024-04-03 00:05:01 | [diff] [blame] | 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"> |
Urgau | 120c6b1 | 2024-03-26 12:30:46 | [diff] [blame] | 5 | <img alt="The Rust Programming Language: A language empowering everyone to build reliable and efficient software" |
Zander Milroy | ce4cc9d | 2024-04-03 00:05:01 | [diff] [blame] | 6 | src="https://raw.githubusercontent.com/rust-lang/www.rust-lang.org/master/static/images/rust-social-wide-light.svg" |
Urgau | 120c6b1 | 2024-03-26 12:30:46 | [diff] [blame] | 7 | width="50%"> |
| 8 | </picture> |
Corey Farwell | d2cc79e | 2020-12-23 19:17:34 | [diff] [blame] | 9 | |
Urgau | 120c6b1 | 2024-03-26 12:30:46 | [diff] [blame] | 10 | [Website][Rust] | [Getting started] | [Learn] | [Documentation] | [Contributing] |
| 11 | </div> |
0xf333 | 56d7b9c | 2023-02-27 03:20:09 | [diff] [blame] | 12 | |
Peter Atashian | be43c65 | 2016-06-27 17:51:27 | [diff] [blame] | 13 | This is the main source code repository for [Rust]. It contains the compiler, |
Andreas Jonson | 30659cd | 2020-07-19 14:53:37 | [diff] [blame] | 14 | standard library, and documentation. |
Nick Hamann | 74f1818 | 2015-05-15 05:43:40 | [diff] [blame] | 15 | |
Alex Touchet | 8915ba7 | 2022-12-29 05:47:09 | [diff] [blame] | 16 | [Rust]: https://www.rust-lang.org/ |
Urgau | 120c6b1 | 2024-03-26 12:30:46 | [diff] [blame] | 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 |
Claes Gill | d7256a6 | 2023-10-19 20:32:11 | [diff] [blame] | 21 | |
Urgau | f6b51c1 | 2024-04-03 05:59:15 | [diff] [blame] | 22 | ## Why Rust? |
| 23 | |
Aarik Pokras | 2d71dd5 | 2024-12-07 21:42:59 | [diff] [blame] | 24 | - **Performance:** Fast and memory-efficient, suitable for critical services, embedded devices, and easily integrated with other languages. |
Urgau | f6b51c1 | 2024-04-03 05:59:15 | [diff] [blame] | 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 | |
Jack Moffitt | 8d64fa3 | 2013-07-18 23:27:43 | [diff] [blame] | 35 | ## Quick Start |
Brian Anderson | c92d2ed | 2012-07-10 05:13:48 | [diff] [blame] | 36 | |
Fuqiao Xue | 09ac478 | 2017-06-09 05:37:22 | [diff] [blame] | 37 | Read ["Installation"] from [The Book]. |
Austin Seipp | 62c4d2c | 2012-01-23 21:53:12 | [diff] [blame] | 38 | |
misagh | 3d23e55 | 2018-12-10 22:28:55 | [diff] [blame] | 39 | ["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html |
Eli Friedman | bbbfed2 | 2015-08-09 21:15:05 | [diff] [blame] | 40 | [The Book]: https://doc.rust-lang.org/book/index.html |
Jack Moffitt | 8d64fa3 | 2013-07-18 23:27:43 | [diff] [blame] | 41 | |
Alex Touchet | 7e64f29 | 2024-01-15 21:57:29 | [diff] [blame] | 42 | ## Installing from Source |
Jack Moffitt | 8d64fa3 | 2013-07-18 23:27:43 | [diff] [blame] | 43 | |
Alex Touchet | 7e64f29 | 2024-01-15 21:57:29 | [diff] [blame] | 44 | If you really want to install from source (though this is not recommended), see |
| 45 | [INSTALL.md](INSTALL.md). |
Austin Seipp | 62c4d2c | 2012-01-23 21:53:12 | [diff] [blame] | 46 | |
Kevin Yap | 24fa6be | 2015-02-21 22:46:06 | [diff] [blame] | 47 | ## Getting Help |
Brian Anderson | cd1fabe | 2014-08-22 18:04:35 | [diff] [blame] | 48 | |
Joshua Nelson | a06e5de | 2022-12-24 01:03:50 | [diff] [blame] | 49 | See https://www.rust-lang.org/community for a list of chat platforms and forums. |
Steve Klabnik | f645cad | 2015-02-13 17:26:44 | [diff] [blame] | 50 | |
| 51 | ## Contributing |
| 52 | |
Joshua Nelson | a06e5de | 2022-12-24 01:03:50 | [diff] [blame] | 53 | See [CONTRIBUTING.md](CONTRIBUTING.md). |
Camelid | 8783c62 | 2020-09-02 00:48:15 | [diff] [blame] | 54 | |
Brian Anderson | c92d2ed | 2012-07-10 05:13:48 | [diff] [blame] | 55 | ## License |
Austin Seipp | 62c4d2c | 2012-01-23 21:53:12 | [diff] [blame] | 56 | |
Alex Touchet | 8915ba7 | 2022-12-29 05:47:09 | [diff] [blame] | 57 | Rust is primarily distributed under the terms of both the MIT license and the |
| 58 | Apache License (Version 2.0), with portions covered by various BSD-like |
| 59 | licenses. |
Austin Seipp | 62c4d2c | 2012-01-23 21:53:12 | [diff] [blame] | 60 | |
Peter Atashian | be43c65 | 2016-06-27 17:51:27 | [diff] [blame] | 61 | See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and |
| 62 | [COPYRIGHT](COPYRIGHT) for details. |
Andrew Xu | 8ffb6fd | 2019-04-06 10:04:06 | [diff] [blame] | 63 | |
| 64 | ## Trademark |
Andrew Xu | 8ffb6fd | 2019-04-06 10:04:06 | [diff] [blame] | 65 | |
Liigo Zhuang | 9c65f9f | 2021-05-26 02:51:13 | [diff] [blame] | 66 | [The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo |
Alex Touchet | 8915ba7 | 2022-12-29 05:47:09 | [diff] [blame] | 67 | trademarks and logos (the "Rust Trademarks"). |
Andrew Xu | 8ffb6fd | 2019-04-06 10:04:06 | [diff] [blame] | 68 | |
Alex Touchet | 8915ba7 | 2022-12-29 05:47:09 | [diff] [blame] | 69 | If you want to use these names or brands, please read the |
| 70 | [media guide][media-guide]. |
Andrew Xu | 8ffb6fd | 2019-04-06 10:04:06 | [diff] [blame] | 71 | |
Andrew Xu | 98beb12 | 2019-04-12 14:14:21 | [diff] [blame] | 72 | Third-party logos may be subject to third-party copyrights and trademarks. See |
| 73 | [Licenses][policies-licenses] for details. |
| 74 | |
Liigo Zhuang | 2caaa07 | 2021-05-20 10:11:01 | [diff] [blame] | 75 | [rust-foundation]: https://foundation.rust-lang.org/ |
Alex Touchet | 8915ba7 | 2022-12-29 05:47:09 | [diff] [blame] | 76 | [media-guide]: https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/ |
Andrew Xu | 98beb12 | 2019-04-12 14:14:21 | [diff] [blame] | 77 | [policies-licenses]: https://www.rust-lang.org/policies/licenses |