dimforge / parry

2D and 3D collision-detection library for Rust.
https://parry.rs
Apache License 2.0
567 stars 100 forks source link

Provide basic usage examples in the documentation #69

Open garma83 opened 2 years ago

garma83 commented 2 years ago

As in title. I have the feeling you guys might be seriously underestimating the importance of this.

Examples required:

Even if you just 'dump' say 10 code examples in the index of the documentation, that would already go a long way.

EriKWDev commented 2 years ago

I agree the documentation is very bare bones, but shout-out to the examples directory https://github.com/dimforge/parry/tree/master/crates/parry2d/examples as well as the tests at https://github.com/dimforge/parry/tree/master/crates/parry2d/tests

More complete examples would be nice. Perhaps more of a complete demo like a platformer using some rendering library like macroquad together with physics from parry would go much further in terms of how to actually use the library, not just demonstrating that it works in very limited examples.

Also, having the "gatting started" guide tell us nothing more than how to add the dependency to Cargo.toml would be appreciated xP (https://parry.rs/docs/user_guide/getting_started)