Add README to benches #11508
Merged
Add README to benches #11508
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rparrett
reviewed
Jan 24, 2024
benches/README.md
Outdated
|
|
||
| ## Running the benchmarks | ||
|
|
||
| 1. If cargo isn't already installed, [install it](https://www.rust-lang.org/tools/install). |
There was a problem hiding this comment.
Do we really need to walk users through installing cargo here? If they don't have cargo, then they likely also don't have other required dependencies.
Maybe just mention that bevy has some dependencies and link off to https://bevyengine.org/learn/book/getting-started/setup/ or something?
There was a problem hiding this comment.
I changed the wording and made it link to the website.
benches/README.md
Outdated
|
|
||
| ## Criterion | ||
|
|
||
| Bevy's benchmarks use [Criterion](https://crates.io/crates/criterion) to chart and track benchmarks over time. If you want to learn more about using Criterion for benchmarking, you can read the [Criterion.rs documentation](https://bheisler.github.io/criterion.rs/book/criterion_rs.html). |
There was a problem hiding this comment.
"benchmarks use criterion to chart and track benchmarks over time" feels a bit misleading.
Individual developers can generate charts and/or compare a particular set of changes against a baseline.
There was a problem hiding this comment.
Changed the wording a bit.
alice-i-cecile
added
the
C-Benchmarks
rparrett
reviewed
Jan 24, 2024
rparrett
approved these changes
Jan 24, 2024
Co-authored-by: Rob Parrett <robparrett@gmail.com>
alice-i-cecile
approved these changes
Jan 24, 2024
alice-i-cecile
added
the
S-Ready-For-Final-Review
tjamaan
pushed a commit
to tjamaan/bevy
that referenced
this pull request
Feb 6, 2024
# 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.