summaryrefslogtreecommitdiff
path: root/benches
diff options
context:
space:
mode:
authorHenry Gressmann <mail@henrygressmann.de>2024-01-28 14:30:39 +0100
committerHenry Gressmann <mail@henrygressmann.de>2024-01-28 14:30:39 +0100
commit51d0c63f7e6d65204d6fe4ec3c378ef3fbedf119 (patch)
tree9700a1b1864005c5f852bf7e50a8f50912150146 /benches
parentf26a0caadab5da373c00ed1269c98d58fec3dec0 (diff)
docs: architecture
Signed-off-by: Henry Gressmann <mail@henrygressmann.de>
Diffstat (limited to 'benches')
-rw-r--r--benches/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/benches/README.md b/benches/README.md
new file mode 100644
index 0000000..6ed8cc5
--- /dev/null
+++ b/benches/README.md
@@ -0,0 +1,13 @@
+# Benchmark results
+
+Coming soon.
+
+# Benchmarking
+
+Benchmarks are run using [Criterion.rs](https://github.com/bheisler/criterion.rs) and can be found in the `benches` directory.
+
+## Running benchmarks
+
+```sh
+$ cargo bench --bench <name>
+```