Skip to content

Commit

Permalink
improve documentation regarding the html reports feature (#662)
Browse files Browse the repository at this point in the history
  • Loading branch information
bluenote10 authored Mar 11, 2023
1 parent 27642b4 commit a6d7650
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ To start with Criterion.<span></span>rs, add the following to your `Cargo.toml`

```toml
[dev-dependencies]
criterion = "0.4"
criterion = { version = "0.4", features = ["html_reports"] }

[[bench]]
name = "my_benchmark"
Expand Down Expand Up @@ -107,7 +107,7 @@ First, thank you for contributing.
One great way to contribute to Criterion.<span></span>rs is to use it for your own benchmarking needs and report your experiences, file and comment on issues, etc.

Code or documentation improvements in the form of pull requests are also welcome. If you're not
sure what to work on, try checking the
sure what to work on, try checking the
[Beginner label](https://github.com/bheisler/criterion.rs/issues?q=is%3Aissue+is%3Aopen+label%3ABeginner).

If your issues or pull requests have no response after a few days, feel free to ping me (@bheisler).
Expand Down
8 changes: 8 additions & 0 deletions book/src/user_guide/plots_and_graphs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ understanding of the behavior of the benchmark. These charts will be generated w
it is not available. The examples below were generated using the gnuplot backend, but the plotters
ones are similar.

Note that in older versions of criterion.rs html reports were enabled by default. Recent versions
have introduced a cargo feature for plot and html generation. In order to activate the html report
generation make sure that your `Cargo.toml` activates the feature:

```toml
criterion = { version = "0.4", features = ["html_reports"] }
```

## File Structure

The plots and saved data are stored under `target/criterion/$BENCHMARK_NAME/`. Here's an example of
Expand Down

0 comments on commit a6d7650

Please sign in to comment.