From 8b3a40f9a3c9735381c733e3d101aa0612c3801c Mon Sep 17 00:00:00 2001 From: michele-akina Date: Sun, 1 Nov 2026 18:06:32 +0100 Subject: [PATCH] docs: update ARCHITECTURE.md for crates/ layout and removed benchmark folders Co-Authored-By: Claude Sonnet 5.5 --- ARCHITECTURE.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index a200b9f80..fe806a715 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -2,16 +2,15 @@ The architecture of this repository is a bit unusual because we are using some tricks to have both the 2D and 3D version of Rapier share the same code-base. Here are the main folders: -- **`build/`**: contains one folder per Rapier crate (for the 2D, 3D, `f32`, and `f64` versions). Each - crate has its own `Cargo.toml` file that adjusts some cargo features, and reference the `src` folder. +- **`crates/`**: contains one folder per published crate: the 2D, 3D, `f32`, and `f64` versions of Rapier, the + testbed crates, and the URDF, MJCF and mesh loaders. Each Rapier crate has its own `Cargo.toml` file that + adjusts some cargo features, and references the `src` folder. - **`src/`**: contains the actual `.rs` source code of the Rapier physics engine. - **`src_testbed/`**: contains the `.rs` source code of the Rapier testbed (which our examples are based on). - **`examples2d/`**: simple 2D scenes showcasing some of Rapier's capabilities. Run them with `cargo run --release --bin all_examples2`. - **`examples3d/`**: simple 3D scenes showcasing some of Rapier's capabilities. Run them with `cargo run --release --bin all_examples3`. -- **`benchmarks2d/`**: a set of 2D stress-tests, to see how Rapier performs when it has lots of elements - to simulate. -- **`benchmarks3d/`**: a set of 3D stress-tests, to see how Rapier performs when it has lots of elements - to simulate. We use the these benchmarks to track the performances of Rapier after some changes, - and spot unexpected regressions: https://www.rapier.rs/benchmarks/ \ No newline at end of file +- **`bindings/`**: C, Python, TypeScript and Bevy bindings. + +Benchmarks are tracked at https://www.rapier.rs/benchmarks/