mirror of https://github.com/bevyengine/bevy synced 2024-11-10 07:04:33 +00:00

History

Mike 3d460e98ec Fix CI bench compile check (#14728 ) # Objective - Fixes #14723 ## Solution - add the manifest path to the cargo command ## Testing - ran `cargo run -p ci -- bench-check` locally		2024-08-14 13:23:00 +00:00
..
benches	Fix CI bench compile check (#14728 )	2024-08-14 13:23:00 +00:00
Cargo.toml	Fix CI bench compile check (#14728 )	2024-08-14 13:23:00 +00: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.