Skip to content

Commit

Permalink
Add benchmark documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TrAyZeN committed Mar 28, 2024
1 parent 09a1b38 commit b60a141
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

An experimental side channel attacks library written in Rust.

## Benchmark
To reduce benchmark variance it is advised to follow [these instructions](https://google.github.io/benchmark/reducing_variance.html).

Then to run benchmarks, run
```sh
cargo bench
```

Benchmark report can found under `target/criterion/report/index.html`.

## License

Licensed under either of
Expand Down

0 comments on commit b60a141

Please sign in to comment.