Skip to content

Commit

Permalink
explain html_reports feature in html_report.md (#621)
Browse files Browse the repository at this point in the history
  • Loading branch information
frederikhors committed Aug 10, 2023
1 parent 6e8c562 commit 7feeb35
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions book/src/user_guide/html_report.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# HTML Report

Starting with Criterion.rs 0.4.0 HTML reports must be explicitly enabled via the `html_reports` [feature](https://doc.rust-lang.org/cargo/reference/features.html#dependency-features):
```toml
[dev-dependencies]
criterion = {version = "0.4.0", features = ["html_reports"] }
```
Criterion.rs can generate an HTML report displaying the results of the benchmark under
`target/criterion/reports/index.html`. By default, the plots are generated using
[gnuplot](http://www.gnuplot.info/) if it is available, or the
Expand Down

0 comments on commit 7feeb35

Please sign in to comment.