summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Brown <gmb60@cam.ac.uk>2021-05-13 18:09:07 +0100
committerGreg Brown <gmb60@cam.ac.uk>2021-05-13 18:09:07 +0100
commit80be0eb048268ea467b3d066fc947c5bd4310562 (patch)
treeb13886c60b0e0a38ca1180ed2d3e5f5a6598a486
parent387959675cd53b3c75ad9b6215b07843f8c8f1d8 (diff)
Update README.HEADmaster
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9ca23eb..e0227a6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
# Chomp
A typed, algebraic parser generator.
+
+# Dependencies
+
+* [`cargo`] build tool for Rust, version 1.51.0 or greater.
+
+`cargo`: https://doc.rust-lang.org/cargo/
+
+# Running tests
+
+To run all tests, execute the following command:
+
+```console
+cargo test --workspace
+```
+
+# Running benchmarks
+
+To run benchmarks, execute the following command:
+
+```console
+cargo benchmark --workspace
+```