mirror of https://github.com/bevyengine/bevy synced 2024-09-20 06:22:01 +00:00

History

BD103 9ee02e87d3 Remove `version` field for non-publish crates and update descriptions (#13100 ) # Objective - The [`version`] field in `Cargo.toml` is optional for crates not published on <https://crates.io>. - We have several `publish = false` tools in this repository that still have a version field, even when it's not useful. [`version`]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field ## Solution - Remove the [`version`] field for all crates where `publish = false`. - Update the description on a few crates and remove extra newlines as well.		2024-04-26 11:55:03 +00:00
..
benches	Cluster small table/archetype into single Task in parallel iteration (#12846 )	2024-04-04 07:09:26 +00:00
Cargo.toml	Remove `version` field for non-publish crates and update descriptions (#13100 )	2024-04-26 11:55:03 +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.