benches.md

Benchmarking Guide

Benchmarking is performed using criterion.

Running

To execute benchmarks, run cargo bench from the root directory.

The output can be found in /target/criterion/your_bench_target. It constructs html reports that can be viewed in a browser.

Adding new Benches

To add a new bench:

1. create a new file under etf-crypto-primitives/benches for example my_new_bench.rs
2. register your benchmark in the etf-crypto-primitives Cargo.toml by adding:

[[bench]]
name = "my_new_bench"
harness = false