Add README for tools/benchmark

6 years ago · 70a6fab636
parent 163ff20508
commit 70a6fab636
1 changed files with 7 additions and 0 deletions
--- a/tools/benchmark/README.md
+++ b/tools/benchmark/README.md
@ -0,0 +1,7 @@
+This directory contains the benchmark suite that measures the speed of parsers generated by PEG.js on various inputs. Its main goal is to provide data for code generator optimizations.
+
+From the root of the repository:
+
+```sh
+yarn benchmark
+```