src/README.md

   1 This directory contains the source code of the rust project, including:
   2 - `rustc` and its tests
   3 - `libstd`
   4 - Various submodules for tools, like rustdoc, rls, etc.
   5
   6 For more information on how various parts of the compiler work, see the [rustc guide].
   7
   8 Their is also useful content in the following READMEs, which are gradually being moved over to the guide:
   9 - https://github.com/rust-lang/rust/tree/master/src/librustc/ty/query
  10 - https://github.com/rust-lang/rust/tree/master/src/librustc/dep_graph
  11 - https://github.com/rust-lang/rust/blob/master/src/librustc/infer/region_constraints
  12 - https://github.com/rust-lang/rust/tree/master/src/librustc/infer/higher_ranked
  13 - https://github.com/rust-lang/rust/tree/master/src/librustc/infer/lexical_region_resolve
  14
  15 [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/about-this-guide.html