Skip to content

Commit 2f2714a

Browse files
authored
Merge pull request #7 from nikomatsakis/master
basic setup, part 1
2 parents 767fc97 + 5e297be commit 2f2714a

19 files changed

+25
-3
lines changed

README.md

+25-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1-
An attempt to document how the compiler works. The intention is to
2-
bootstrap this "in repo" and eventually move the text over into the
3-
main rustc repo.
1+
This is a collaborate effort to build a guide that explains how rustc
2+
works. The aim of the guide is to help new contributors get oriented
3+
to rustc, as well as to help more experienced folks in figuring out
4+
some new part of the compiler that they haven't worked on before.
5+
6+
The guide can be useful today, but it has a lot of work still go.
7+
Once it gets more complete, the plan is probably to move it into the
8+
[main Rust repository](https://github.com/rust-lang/rust/).
9+
10+
### Contributing to the guide
11+
12+
If you'd like to help finish the guide, we'd love to have you! The
13+
main tracking issue for the guide
14+
[can be found here](https://github.com/rust-lang-nursery/rustc-guide/issues/6). From
15+
there, you can find a list of all the planned chapters and subsections
16+
-- if you think something is missing, please open an issue about it!
17+
Otherwise, find a chapter that sounds interesting to you and then go
18+
to its associated issue. There should be a list of things to do.
19+
20+
**In general, if you don't know how the compiler works, that is not a
21+
problem!** In that case, what we will do is to schedule a bit of time
22+
for you to talk with someone who **does** know the code, or who wants
23+
to pair with you and figure it out. Then you can work on writing up
24+
what you learned.
25+
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)