summaryrefslogtreecommitdiffstats
path: root/src/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/README.md')
-rw-r--r--src/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 000000000..9752bc3f6
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,9 @@
+This directory contains the source code of the rust project, including:
+
+- The test suite
+- The bootstrapping build system
+- Various submodules for tools, like rustdoc, rls, etc.
+
+For more information on how various parts of the compiler work, see the [rustc dev guide].
+
+[rustc dev guide]: https://rustc-dev-guide.rust-lang.org/about-this-guide.html