From f6b51c10f3c23a1079d59e01c5a2c2b92955378f Mon Sep 17 00:00:00 2001 From: Urgau Date: Wed, 3 Apr 2024 07:59:15 +0200 Subject: [PATCH 1/3] Add Why Rust? section to the README.md and mention our tools --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6d6383351caf7..2efaab2c290aa 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,19 @@ If you wish to _contribute_ to the compiler, you should read +## 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]. From 120c6b16845c4f70601a0ee1ffe2172f1b0c8c95 Mon Sep 17 00:00:00 2001 From: Urgau Date: Tue, 26 Mar 2024 13:30:46 +0100 Subject: [PATCH 2/3] Add nice header to our README.md --- README.md | 34 +++++++++++++++------------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 2efaab2c290aa..c3b72062d8838 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,23 @@ -# The Rust Programming Language - -[![Rust Community](https://img.shields.io/badge/Rust_Community%20-Join_us-brightgreen?style=plastic&logo=rust)](https://www.rust-lang.org/community) +
+ + + + The Rust Programming Language: A language empowering everyone to build reliable and efficient software + + +[Website][Rust] | [Getting started] | [Learn] | [Documentation] | [Contributing] +
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. - -
-Table of Contents - -- [Quick Start](#quick-start) -- [Installing from Source](#installing-from-source) -- [Getting Help](#getting-help) -- [Contributing](#contributing) -- [License](#license) -- [Trademark](#trademark) - -
+[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? From ce4cc9df960ec5c0a840d75e7e57284bfd80d25d Mon Sep 17 00:00:00 2001 From: Zander Milroy Date: Tue, 2 Apr 2024 20:05:01 -0400 Subject: [PATCH 3/3] Use SVG logos in the README.md. These should likely eventually reference the rust-lang.org site instead of raw.githubusercontent.com --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c3b72062d8838..3690a9c93c528 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@
- - + + The Rust Programming Language: A language empowering everyone to build reliable and efficient software