From: Matt Corallo <git@bluematt.me>
Date: Tue, 2 May 2023 17:04:11 +0000 (+0000)
Subject: Add trivial README to bench to describe how to run them.
X-Git-Tag: v0.0.116-alpha1~33^2~1
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=6ddc88b8d7d796ac8538b29714016a1c6e5df0ef;p=rust-lightning

Add trivial README to bench to describe how to run them.
---

diff --git a/bench/README.md b/bench/README.md
new file mode 100644
index 000000000..7d4cacc9e
--- /dev/null
+++ b/bench/README.md
@@ -0,0 +1,6 @@
+This crate uses criterion to benchmark various LDK functions.
+
+It can be run as `RUSTFLAGS=--cfg=ldk_bench cargo bench`.
+
+For routing or other HashMap-bottlenecked functions, the `hashbrown` feature
+should also be benchmarked.