mirror of
https://github.com/bevyengine/bevy
synced 2024-11-14 00:47:32 +00:00
99449931d2
# 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 <robparrett@gmail.com>
969 B
969 B
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
benchesdirectory (where this README is located).bevy $ cd benches -
Run the benchmarks with cargo (This will take a while)
bevy/benches $ cargo benchIf 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.