nichkara/rapier
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
Sébastien Crozet
2024-03-23 16:03:26 +01:00
parent 6f8bd99eab
commit 59dc9bfe00
1 changed files with 6 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -35,24 +35,28 @@
## What is Rapier? ## What is Rapier?
Rapier is a set of 2D and 3D physics engines for games, animation, and robotics. These crates 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 are `rapier2d`, `rapier3d`, `rapier2d-f64`, and `rapier3d-f64`. They are written with the Rust
programming language, by the [Dimforge](https://dimforge.com) organization. It is forever free programming language, by the [Dimforge](https://dimforge.com) organization. It is forever free
and open-source! and open-source!
## Roadmap ## Roadmap
We update our roadmap at the beginning of each year. Our 2021 roadmap can be seen We update our roadmap at the beginning of each year. Our 2021 roadmap can be seen
[there](https://www.dimforge.com/blog/2021/01/01/physics-simulation-with-rapier-2021-roadmap/#rapier-roadmap-for-2021). [there](https://www.dimforge.com/blog/2021/01/01/physics-simulation-with-rapier-2021-roadmap/#rapier-roadmap-for-2021).
We regularly give updates about our progress on [our blog](https://www.dimforge.com/blog). We regularly give updates about our progress on [our blog](https://www.dimforge.com/blog).
## Getting started ## Getting started
The easiest way to get started with Rapier is to: The easiest way to get started with Rapier is to:
1. Read the [user-guides](https://www.rapier.rs/docs/). 1. Read the [user-guides](https://www.rapier.rs/docs/).
2. Play with the examples: `cargo run --release --bin all_examples2` and `cargo run --release --bin all_examples3`. 2. Play with the examples: `cargo run --release --bin all_examples2` and `cargo run --release --bin all_examples3`.
Their source code are available on the `examples2d/` and `examples3d/` directory. Their source code are available on the `examples2d/` and `examples3d/` directory.
3. Don't hesitate to ask for help on [Discord](https://discord.gg/vt9DJSW), or by opening an issue on GitHub. 3. Don't hesitate to ask for help on [Discord](https://discord.gg/vt9DJSW), or by opening an issue on GitHub.
## Resources and discussions ## Resources and discussions
- [Dimforge](https://dimforge.com): See all the open-source projects we are working on! Follow our announcements - [Dimforge](https://dimforge.com): See all the open-source projects we are working on! Follow our announcements
on our [blog](https://www.dimforge.com/blog). on our [blog](https://www.dimforge.com/blog).
- [User guide](https://www.rapier.rs/docs/): Learn to use Rapier in your project by reading the official User Guides. - [User guide](https://www.rapier.rs/docs/): Learn to use Rapier in your project by reading the official User Guides.
@@ -63,23 +67,3 @@ The easiest way to get started with Rapier is to:
Please make sure to familiarize yourself with our [Code of Conduct](CODE_OF_CONDUCT.md) Please make sure to familiarize yourself with our [Code of Conduct](CODE_OF_CONDUCT.md)
and our [Contribution Guidelines](CONTRIBUTING.md) before contributing or participating in and our [Contribution Guidelines](CONTRIBUTING.md) before contributing or participating in
discussions with the community. discussions with the community.
## Acknowledgements
Rapier is supported by our **platinum** sponsors:
<p>
<a href="https://embark-studios.com">
<img src="https://www.embark.dev/img/logo_black.png" width="301px">
</a>
</p>
And our gold sponsors:
<p>
<a href="https://fragcolor.com">
<img src="https://dimforge.com/img/fragcolor_logo2_color_black.svg" width="300px">
</a>
<a href="https://resolutiongames.com/">
<img src="https://dimforge.com/img/logo_resolution_games.png" width="300px" />
</a>
</p>