bevy/examples/stress_tests/README.md

# Stress tests

These examples are used to stress test Bevy's performance in various ways. These
should be run with the "stress-test" profile to accurately represent performance
in production, otherwise they will run in cargo's default "dev" profile which is
very slow.

## Example Command

```bash
cargo run --profile stress-test --example <EXAMPLE>
```
Added performance warning when running stress test examples in debug mode (#5029) # Objective Fixes #5028 ## Solution Used #[cfg(debug_assertions)] to display a warning when running examples under stress_tests in debug mode 2022-07-13 19:13:46 +00:00			`# Stress tests`

Add a stress test profile (#6901) # Objective This adds a custom profile for testing against stress tests. Bevy seemingly gets notably faster with LTO turned on. To more accurately depict production level performance, LTO and other rustc-level optimizations should be enabled when performance testing on stress tests. Also updated the stress test docs to reflect that users should be using it. 2022-12-20 15:59:41 +00:00			`These examples are used to stress test Bevy's performance in various ways. These`
			`should be run with the "stress-test" profile to accurately represent performance`
			`in production, otherwise they will run in cargo's default "dev" profile which is`
			`very slow.`

			`## Example Command`

			```bash
			`cargo run --profile stress-test --example <EXAMPLE>`
			```