cuprate-hinto-janai/benches/benchmark/bin/README.md
hinto.janai 24d176ff14
Some checks failed
Audit / audit (push) Has been cancelled
Deny / audit (push) Has been cancelled
example, docs
2024-10-04 17:37:38 -04:00

19 lines
No EOL
676 B
Markdown

## `cuprate-benchmark`
This crate links all benchmarks together into a single binary that can be run as: `cuprate-benchmark`.
`cuprate-benchmark` will run all enabled benchmarks sequentially and print data at the end.
## Benchmarks
Benchmarks are opt-in and enabled via features.
| Feature | Enables which benchmark crate? |
|----------|--------------------------------|
| example | cuprate-benchmark-example |
| database | cuprate-benchmark-database |
## Features
These are features that aren't for enabling benchmarks, but rather for other things.
| Features | Does what |
|----------|-----------|
| json | Prints JSON timings instead of a markdown table