From bb381a7ff7a21cad98d80005a81f2586684f80a0 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Sat, 3 Feb 2018 12:51:06 +0300 Subject: Move tools to a separate package --- docs/TOOLS.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/TOOLS.md (limited to 'docs/TOOLS.md') 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. -- cgit v1.2.3