about summary refs log tree commit diff
path: root/compiler/rustc_llvm/llvm-wrapper/CoverageMappingWrapper.cpp
diff options
context:
space:
mode:
authorJacob Pratt <jacob@jhpratt.dev>2024-04-03 20:17:05 -0400
committerGitHub <noreply@github.com>2024-04-03 20:17:05 -0400
commitc8cd010616d9dfa49864527388e7c065937e94c9 (patch)
treedbce2c0831407708f7cff5971fca83af04697807 /compiler/rustc_llvm/llvm-wrapper/CoverageMappingWrapper.cpp
parent875d2547500f9c588c0537ab12672b4cf844eca4 (diff)
parentce4cc9df960ec5c0a840d75e7e57284bfd80d25d (diff)
downloadrust-c8cd010616d9dfa49864527388e7c065937e94c9.tar.gz
rust-c8cd010616d9dfa49864527388e7c065937e94c9.zip
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](https://github.com/evanw/esbuild/blob/9d1777f23d9b64c186345223d92f319e59388d8b/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 |
|--------|-------|
| ![before](https://github.com/rust-lang/rust/assets/3616612/4afb6753-18a9-4881-919e-2a79328beb5a) | ![after](https://github.com/rust-lang/rust/assets/3616612/408dea7b-5d97-4bb8-a77e-35541ddd50cb) <details> ![after](https://github.com/rust-lang/rust/assets/3616612/76e4a8c6-b61c-46e8-b5ba-4f09c13cfc94) </details> <details> ![after -1](https://github.com/rust-lang/rust/assets/3616612/ed50675c-8301-457c-8b9a-a1199c515fb7) </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.
Diffstat (limited to 'compiler/rustc_llvm/llvm-wrapper/CoverageMappingWrapper.cpp')
0 files changed, 0 insertions, 0 deletions