mirror of https://github.com/bevyengine/bevy synced 2024-12-21 02:23:08 +00:00

History

BD103 cbe1688dcd refactor: make all `criterion_group!`s named `benches` Now the distinguishing factor will be their module path, removing the need to rename the group itself if it switches modules.		2024-12-09 14:39:16 -05:00
..
benches	refactor: make all `criterion_group!`s named `benches`	2024-12-09 14:39:16 -05:00
Cargo.toml	refactor: organize benches to be consistent	2024-12-09 14:16:19 -05:00
README.md	Add README to benches (#11508 )	2024-01-24 17:11:28 +00:00

README.md

Bevy Benchmarks

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

Running the benchmarks

Setup everything you need for Bevy with the setup guide.
Move into the benches directory (where this README is located).
```
bevy $ cd benches
```
Run the benchmarks with cargo (This will take a while)
```
bevy/benches $ cargo bench
```
If you'd like to only compile the benchmarks (without running them), you can do that like this:
```
bevy/benches $ cargo bench --no-run
```

Criterion

Bevy's benchmarks use 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.