From cab201161303cba849d14c7b8a808fea0d2d6b6d Mon Sep 17 00:00:00 2001 From: "hinto.janai" Date: Wed, 9 Oct 2024 17:23:32 -0400 Subject: [PATCH] lib readme --- benches/benchmark/lib/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/benches/benchmark/lib/README.md b/benches/benchmark/lib/README.md index 5ad92b7..6abce6b 100644 --- a/benches/benchmark/lib/README.md +++ b/benches/benchmark/lib/README.md @@ -1 +1,16 @@ ## `cuprate-benchmark-lib` +This crate is the glue between +[`cuprate-benchmark`](https://github.com/Cuprate/cuprate/tree/benches/benches/benchmark/bin) +and all the benchmark crates. + +It defines the [`cuprate_benchmark_lib::Benchmark`] trait, +which is the behavior of all benchmarks. + +See the [`cuprate-benchmark-example`](https://github.com/Cuprate/cuprate/tree/benches/benches/benchmark/example) +crate to see an example implementation of this trait. + +After implementing this trait, a few steps must +be done such that the `cuprate-benchmark` binary +can actually run your benchmark crate; see the +[`Benchmarking` section in the Architecture book](https://architecture.cuprate.org/benchmarking/intro.html) +to see how to do this. \ No newline at end of file