rearrange hierarchy and readme

dimforge · Jul 11, 2024 · 3bb2b1a · 3bb2b1a
1 parent 74315eb
commit 3bb2b1a
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 32 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,5 +1,5 @@
 [workspace]
-members = ["bevy_rapier2d", "bevy_rapier3d", "custom_benches"]
+members = ["bevy_rapier2d", "bevy_rapier3d"]
 resolver = "2"
 
 [profile.dev]

diff --git a/benches_common/Cargo.toml b/benches_common/Cargo.toml
diff --git a/bevy_rapier3d/Cargo.toml b/bevy_rapier3d/Cargo.toml
@@ -53,7 +53,6 @@ log = "0.4"
 serde = { version = "1", features = ["derive"], optional = true }
 
 [dev-dependencies]
-benches_common = { version = "0.1", path = "../benches_common" }
 bevy = { version = "0.14", default-features = false, features = [
     "x11",
     "tonemapping_luts",

diff --git a/benches_common/src/lib.rs → bevy_rapier3d/benches/common/mod.rs b/benches_common/src/lib.rs → bevy_rapier3d/benches/common/mod.rs
diff --git a/bevy_rapier3d/benches/cubes.rs b/bevy_rapier3d/benches/cubes.rs
@@ -2,7 +2,10 @@
 //!
 //! <https://github.com/Jondolf/avian/blob/81290423e146264120cf9711af716f6faf669717/crates/avian3d/benches/cubes.rs>
 
-use benches_common::bench_app_updates;
+mod common;
+
+use common::bench_app_updates;
+
 use bevy::prelude::*;
 use bevy_rapier3d::math::*;
 use bevy_rapier3d::prelude::*;

diff --git a/bevy_rapier3d/benches/many_pyramids3.rs b/bevy_rapier3d/benches/many_pyramids3.rs
@@ -2,6 +2,10 @@
 //!
 //! <https://github.com/dimforge/rapier/blob/87ada34008f4a1a313ccf8c3040040bab4f10e69/benchmarks3d/many_pyramids3.rs>
 
+mod common;
+
+use common::bench_app_updates;
+
 use benches_common::bench_app_updates;
 use bevy::prelude::*;
 use bevy_rapier3d::math::*;

diff --git a/custom_benches/Cargo.toml → bevy_rapier_benches3d/Cargo.toml b/custom_benches/Cargo.toml → bevy_rapier_benches3d/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "custom_benches"
+name = "bevy_rapier_benches3d"
 version = "0.1.0"
 description = "Custom benchmarks for bevy_rapier."
 readme = "./README.md"

diff --git a/bevy_rapier_benches3d/README.md b/bevy_rapier_benches3d/README.md
@@ -0,0 +1,24 @@
+# bevy_rapier custom benches
+
+`bevy_rapier_benches3d` 's objective is to measure timings with detailed information
+without spending too much time running multiple times expensive benchmarks.
+
+It is implemented as a standalone binary, running different scenes setup, gathering information
+and outputs them at the end.
+
+```sh
+cargo run --release -p bevy_rapier_benches3d
+```
+
+## cargo bench
+
+For short-lived benchmarks based on statistical analysis,
+benchmarks can be run through the [divan](https://github.com/nvzqz/divan) bench harness.
+
+```sh
+cargo bench -p bevy_rapier3d
+```
+
+## Other resources
+
+- [Bevy profiling](https://github.com/bevyengine/bevy/blob/main/docs/profiling.md)
diff --git a/custom_benches/src/main.rs → bevy_rapier_benches3d/src/main.rs b/custom_benches/src/main.rs → bevy_rapier_benches3d/src/main.rs
diff --git a/custom_benches/README.md b/custom_benches/README.md