Merge #38

38: Move tools to a separate package r=matklad a=matklad

1 files changed, 30 insertions, 0 deletions

diff --git a/docs/TOOLS.md b/docs/TOOLS.md
new file mode 100644
index 000000000..1fcfa2dec
--- /dev/null
+++ b/docs/TOOLS.md
@@ -0,0 +1,30 @@
+# Tools used to implement libsyntax
+
+libsyntax uses several tools to help with development. 
+
+Each tool is a binary in the [tools/](../tools) package. 
+You can run them via `cargo run` command. 
+
+```
+cargo run --package tools --bin tool
+```
+
+There are also aliases in [./cargo/config](../.cargo/config), 
+so the following also works:
+
+```
+cargo tool
+```
+
+
+# Tool: `gen`
+
+This tool reads a "grammar" from [grammar.ron](../grammar.ron) and
+generates the `syntax_kinds.rs` file. You should run this tool if you 
+add new keywords or syntax elements.
+
+
+# Tool: 'parse'
+
+This tool reads rust source code from the standard input, parses it,
+and prints the result to stdout.