mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #208 from rust-lang-nursery/readme 

Update a few parts of the readme
This commit is contained in:
Niko Matsakis 2018-10-15 13:17:04 -04:00 committed by GitHub
parent 4b8ba80e57 86301aa315
commit b06fed1b47
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -10,18 +10,15 @@ You may also find the rustdocs [for the compiler itself][rustdocs] useful.
[rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/ [rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
The guide can be useful today, but it has a lot of work still go. The guide can be useful today, but it has a lot of work still go.
Once it gets more complete, the plan is probably to move it into the
[main Rust repository](https://github.com/rust-lang/rust/).
### Contributing to the guide ### Contributing to the guide
If you'd like to help finish the guide, we'd love to have you! The If you'd like to help improve the guide, we'd love to have you! You can find
main tracking issue for the guide plenty of issues on the [issue
[can be found here](https://github.com/rust-lang-nursery/rustc-guide/issues/6). From tracker](https://github.com/rust-lang-nursery/rustc-guide/issue). Just post a
there, you can find a list of all the planned chapters and subsections. comment on the issue you would like to work on to make sure that we don't
If you think something is missing, please open an issue about it! accidentally duplicate work. If you think something is missing, please open an
Otherwise, find a chapter that sounds interesting to you and then go issue about it!
to its associated issue. There should be a list of things to do.
**In general, if you don't know how the compiler works, that is not a **In general, if you don't know how the compiler works, that is not a
problem!** In that case, what we will do is to schedule a bit of time problem!** In that case, what we will do is to schedule a bit of time
@ -29,6 +26,10 @@ for you to talk with someone who **does** know the code, or who wants
to pair with you and figure it out. Then you can work on writing up to pair with you and figure it out. Then you can work on writing up
what you learned. what you learned.
In general, when writing about a particular part of the compiler's code, we
recommend that you link to the relevant parts of the [rustc
rustdocs][rustdocs].
To help prevent accidentally introducing broken links, we use the To help prevent accidentally introducing broken links, we use the
`mdbook-linkcheck`. If installed on your machine `mdbook` will automatically `mdbook-linkcheck`. If installed on your machine `mdbook` will automatically
invoke this link checker, otherwise it will emit a warning saying it couldn't invoke this link checker, otherwise it will emit a warning saying it couldn't