diff --git a/src/uu/factor/BENCHMARKING.md b/src/uu/factor/BENCHMARKING.md new file mode 100644 index 000000000..e93bed95e --- /dev/null +++ b/src/uu/factor/BENCHMARKING.md @@ -0,0 +1,12 @@ +# Benchmarking `factor` + +## Microbenchmarking deterministic functions + +We currently use [`criterion`] to benchmark deterministic functions, +such as `gcd` and `table::factor`. + +Those benchmarks can be simply executed with `cargo bench` as usual, +but may require a recent version of Rust, *i.e.* the project's minimum +supported version of Rust does not apply to the benchmarks. + +[`criterion`]: https://bheisler.github.io/criterion.rs/book/index.html