Rollup merge of #123093 - Urgau:improve-readme, r=workingjubilee
Add a nice header to our README.md
This PR improves our README, it is greatly inspired by [esbuild](9d1777f23d/README.md
) README.
Context: As was reading https://johnjago.com/great-docs/ I though we could greatly improve ours. So that's what I did.
It provides direct "quick-access" links to pages in rust-lang.org.
The "Why Rust?" section is ~~a direct copy/paste of the same~~ modified version of section in [rust-lang.org](https://www.rust-lang.org/).
| Before | After |
|--------|-------|
|  |  <details>  </details> <details>  </details> |
Note: I removed the manual TOC, since GitHub provides it's own at the top right corner and I don't think it's needed anymore.
Same for the notice about the readme being for users, it's now clear enough and that notice was distracting anyway.
This commit is contained in:
commit
c8cd010616
37
README.md
37
README.md
@ -1,27 +1,36 @@
|
||||
# The Rust Programming Language
|
||||
<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">
|
||||
<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"
|
||||
width="50%">
|
||||
</picture>
|
||||
|
||||
[](https://www.rust-lang.org/community)
|
||||
[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.
|
||||
|
||||
[Rust]: https://www.rust-lang.org/
|
||||
[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
|
||||
|
||||
**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.
|
||||
## Why Rust?
|
||||
|
||||
<details>
|
||||
<summary>Table of Contents</summary>
|
||||
- **Performance:** Fast and memory-efficient, suitable for critical services, embedded devices, and easily integrate with other languages.
|
||||
|
||||
- [Quick Start](#quick-start)
|
||||
- [Installing from Source](#installing-from-source)
|
||||
- [Getting Help](#getting-help)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Trademark](#trademark)
|
||||
- **Reliability:** Our rich type system and ownership model ensure memory and thread safety, reducing bugs at compile-time.
|
||||
|
||||
</details>
|
||||
- **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
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user