Skip to content

Commit

Permalink
Add README to benches (#11508)
Browse files Browse the repository at this point in the history
# Objective

It is unclear how to run Bevy's benchmarks

## Solution

Add a README to the benches, with documentation that tells you what the
benchmarks are, and how to run them.

---------

Co-authored-by: Rob Parrett <[email protected]>
  • Loading branch information
doonv and rparrett authored Jan 24, 2024
1 parent 9808713 commit 9944993
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions benches/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Bevy Benchmarks

This is a crate with a collection of benchmarks for Bevy, separate from the rest of the Bevy crates.

## Running the benchmarks

1. Setup everything you need for Bevy with the [setup guide](https://bevyengine.org/learn/book/getting-started/setup/).
2. Move into the `benches` directory (where this README is located).

```sh
bevy $ cd benches
```

3. Run the benchmarks with cargo (This will take a while)

```sh
bevy/benches $ cargo bench
```

If you'd like to only compile the benchmarks (without running them), you can do that like this:
```sh
bevy/benches $ cargo bench --no-run
```
## Criterion
Bevy's benchmarks use [Criterion](https://crates.io/crates/criterion). If you want to learn more about using Criterion for comparing performance against a baseline or generating detailed reports, you can read the [Criterion.rs documentation](https://bheisler.github.io/criterion.rs/book/criterion_rs.html).

0 comments on commit 9944993

Please sign in to comment.