From 58ee3f0b310dc9de1822da9ac3964326f78d7fbe Mon Sep 17 00:00:00 2001 From: Tab Atkins-Bittner Date: Sat, 18 Jan 2025 07:51:14 -0800 Subject: [PATCH] Explain the purpose of the benchmarks --- tests/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tests/README.md b/tests/README.md index 848aeb0..3b2a615 100644 --- a/tests/README.md +++ b/tests/README.md @@ -54,3 +54,7 @@ please send a PR. If you think the disagreement is due to a genuine error or oversight in the KDL specification, please open an issue explaining the matter and the change will be considered for the next version of the KDL spec. + +# Benchmarks + +The `benchmarks` folder contains some large or gnarly documents intended to be used to stress-test your parser and help with profiling. They are intentionally not part of the testsuite, and just provided for your own personal benefit.