mirror of
https://github.com/hinto-janai/cuprate.git
synced 2025-03-12 09:31:30 +00:00
add benches/
readme
This commit is contained in:
parent
c837f2f48e
commit
c52108ea86
1 changed files with 20 additions and 1 deletions
|
@ -1 +1,20 @@
|
|||
# TODO
|
||||
# Benches
|
||||
This is the suite of benchmarking programs that allows benchmarking Cuprate with [`criterion`](https://bheisler.github.io/criterion.rs/book/criterion_rs.html).
|
||||
|
||||
For more information on `cargo bench` and `criterion`:
|
||||
- https://doc.rust-lang.org/cargo/commands/cargo-bench.html
|
||||
- https://bheisler.github.io/criterion.rs/book/criterion_rs.html
|
||||
|
||||
1. [Usage](#Usage)
|
||||
1. [File Structure](#file-structure)
|
||||
|
||||
# Usage
|
||||
Ensure the system is as quiet as possible (no background tasks) before starting and during the benchmarks.
|
||||
|
||||
To start all benchmarks, run:
|
||||
```bash
|
||||
cargo bench TODO
|
||||
```
|
||||
|
||||
# File Structure
|
||||
TODO
|
Loading…
Reference in a new issue