From 6c641806760851679782816cd9822f21d74e37d2 Mon Sep 17 00:00:00 2001 From: Soispha Date: Wed, 27 Mar 2024 23:04:14 +0100 Subject: [PATCH] docs(README): Mention the binary --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 73ffc80..22a1321 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,10 @@ Trixy contains integration tests in the `./tests` directory. These are maintaine `./scripts/tests.sh` script. Take a look at it's `--help` output for further usage information. +This crate also contains a binary, which can help with manual testing and inspecting of the +generated AST. The `cargo run --features 'build-binary' -- --help` output should provide +all required information. + Tests are (as of now) only positive, i.e. they can only test successful situations. Failing test will probably be supported in the future.