summaryrefslogtreecommitdiffstats
path: root/compiler/rustc_driver/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--compiler/rustc_driver/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/compiler/rustc_driver/README.md b/compiler/rustc_driver/README.md
new file mode 100644
index 000000000..37dc7f6ba
--- /dev/null
+++ b/compiler/rustc_driver/README.md
@@ -0,0 +1,10 @@
+The `driver` crate is effectively the "main" function for the rust
+compiler. It orchestrates the compilation process and "knits together"
+the code from the other crates within rustc. This crate itself does
+not contain any of the "main logic" of the compiler (though it does
+have some code related to pretty printing or other minor compiler
+options).
+
+For more information about how the driver works, see the [rustc dev guide].
+
+[rustc dev guide]: https://rustc-dev-guide.rust-lang.org/rustc-driver.html