SyntheticBird/cuprate-hinto-janai
1
0
Fork 0
mirror of https://github.com/hinto-janai/cuprate.git synced 2025-03-12 09:31:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add benches/ readme

Browse source
This commit is contained in:
hinto.janai 2024-06-16 17:40:33 -04:00
parent c837f2f48e
commit c52108ea86
No known key found for this signature in database
GPG key ID: D47CE05FA175A499
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
benches/README.md
View file

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