about summary refs log tree commit diff
path: root/src/libsyntax/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/libsyntax/README.md')
-rw-r--r--src/libsyntax/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/libsyntax/README.md b/src/libsyntax/README.md
new file mode 100644
index 00000000000..3bf735ee868
--- /dev/null
+++ b/src/libsyntax/README.md
@@ -0,0 +1,7 @@
+NB: This crate is part of the Rust compiler. For an overview of the
+compiler as a whole, see
+[the README.md file found in `librustc`](../librustc/README.md).
+
+The `syntax` crate contains those things concerned purely with syntax
+– that is, the AST ("abstract syntax tree"), parser, pretty-printer,
+lexer, macro expander, and utilities for traversing ASTs.