mirror of
https://github.com/hinto-janai/cuprate.git
synced 2025-01-10 04:44:50 +00:00
caa08d5eaa
* add readme * readme, basic examples * name changes, bin impl * example, docs * book * add `cuprate-criterion-example` * docs, tracing * fix clippy * docs * lib readme * json-rpc benchmarks * add to crates.md * add `fixme` * fix `cargo b` failing this `cfg()` existing makes a regular workspace `cargo b` fail * fix cargo.toml
15 lines
No EOL
709 B
Markdown
15 lines
No EOL
709 B
Markdown
## `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 [`crate::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. |