about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorNiko Matsakis <niko@alum.mit.edu>2018-01-17 09:19:24 -0500
committerNiko Matsakis <niko@alum.mit.edu>2018-01-17 09:25:23 -0500
commit51aa31de21cda57abe0742d22f8881de4ef5d904 (patch)
treeb6bdfee9d1222f7a3bf1af7f4f34dfabe752e679 /src/doc/rustc-dev-guide
parentab618a38ee2b679b5af1c6bff8f04a6f61977bfd (diff)
downloadrust-51aa31de21cda57abe0742d22f8881de4ef5d904.tar.gz
rust-51aa31de21cda57abe0742d22f8881de4ef5d904.zip
improve the README
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/README.md28
1 files changed, 25 insertions, 3 deletions
diff --git a/src/doc/rustc-dev-guide/README.md b/src/doc/rustc-dev-guide/README.md
index b8929c1e3f9..beb2507cd21 100644
--- a/src/doc/rustc-dev-guide/README.md
+++ b/src/doc/rustc-dev-guide/README.md
@@ -1,3 +1,25 @@
-An attempt to document how the compiler works. The intention is to
-bootstrap this "in repo" and eventually move the text over into the
-main rustc repo.
+This is a collaborate effort to build a guide that explains how rustc
+works. The aim of the guide is to help new contributors get oriented
+to rustc, as well as to help more experienced folks in figuring out
+some new part of the compiler that they haven't worked on before.
+
+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
+
+If you'd like to help finish the guide, we'd love to have you! The
+main tracking issue for the guide
+[can be found here](https://github.com/rust-lang-nursery/rustc-guide/issues/6). From
+there, you can find a list of all the planned chapters and subsections
+-- if you think something is missing, please open an issue about it!
+Otherwise, find a chapter that sounds interesting to you and then go
+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
+problem!** In that case, what we will do is to schedule a bit of time
+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
+what you learned.
+