SyntheticBird/cuprate-hinto-janai
1
0
Fork 0
mirror of https://github.com/hinto-janai/cuprate.git synced 2024-11-17 00:07:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

lib readme

Browse source
This commit is contained in:
hinto.janai 2024-10-09 17:23:32 -04:00
parent fe6c395d40
commit cab2011613
No known key found for this signature in database
GPG key ID: D47CE05FA175A499
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
benches/benchmark/lib/README.md
View file

@ -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.