5eb5398a7e39d3cfdf0f0266db90bafdc4308936
docs.rs docs to rapier docs
Added a pointer from the module-level cargo docs to the actual docs on `rapier.rs` so other people won't be lost like I was. (Searches for documentation often end up on `docs.rs`, which is not where most of Rapier's docs live. The README has a pointer to the docs, but it isn't as visible once you're on `docs.rs`.) This is the same change as pr89 for `bevy_rapier`. This one is less important less likely to overlook `rapier.rs`, but I think it doesn't hurt. Ideally you'd be able to just include the `README.md` into the lib documentation, but I think that's still a nightly-only feature in cargo doc.
2D and 3D physics engines for the Rust programming language.
What is Rapier?
Rapier is a set of 2D and 3D physics engines for games, animation, and robotics. These crates
are rapier2d, rapier3d, rapier2d-f64, and rapier3d-f64. They are written with the Rust
programming language, by the Dimforge organization. It is forever free
and open-source!
Roadmap
We update our roadmap at the beginning of each year. Our 2021 roadmap can be seen there. We regularly give updates about our progress on our blog.
Getting started
The easiest way to get started with Rapier is to:
- Read the user-guides.
- Play with the examples:
cargo run --release --bin all_examples2andcargo run --release --bin all_examples3. Their source code are available on theexamples2d/andexamples3d/directory. - Don't hesitate to ask for help on Discord, or by opening an issue on GitHub.
Resources and discussions
- Dimforge: See all the open-source projects we are working on! Follow our announcements on our blog.
- User guide: Learn to use Rapier in your project by reading the official User Guides.
- Discord: Come chat with us, get help, suggest features, on Discord!
- NPM packages: Check out our NPM packages for Rapier, if you need to use it with JavaScript/Typescript.
Please make sure to familiarize yourself with our Code of Conduct and our Contribution Guidelines before contributing or participating in discussions with the community.
Platinum sponsors
Rapier is supported by:
Description
Languages
Rust
99.6%
Shell
0.4%