aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSébastien Crozet <developer@crozet.re>2021-04-01 15:21:27 +0200
committerGitHub <noreply@github.com>2021-04-01 15:21:27 +0200
commitbd2dc781f366eda6e9c02bff9cd8ba39c5b6ba21 (patch)
treec5a6af862168865f23b9909ffe7c27e92b07df82 /README.md
parent6e0c1cf8fb44c8d1ba856bd3dcd01b4c5ad8b543 (diff)
parent19e43c44c80c86e23a693c723406b190c76c1208 (diff)
downloadrapier-bd2dc781f366eda6e9c02bff9cd8ba39c5b6ba21.tar.gz
rapier-bd2dc781f366eda6e9c02bff9cd8ba39c5b6ba21.tar.bz2
rapier-bd2dc781f366eda6e9c02bff9cd8ba39c5b6ba21.zip
Merge pull request #159 from dimforge/guides
Add ARCHITECTURE, CODE_OF_CONDUCT, CONTRIBUTING files + flesh out the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 35 insertions, 2 deletions
diff --git a/README.md b/README.md
index aa8853c..341d2d9 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,7 @@
<p align = "center">
<strong>
<a href="https://rapier.rs">Website</a> | <a href="https://rapier.rs/docs/">Documentation</a>
+ </strong>
</p>
-----
@@ -32,10 +33,42 @@
-----
-## Gold sponsors
+## 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](https://dimforge.com) 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](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).
+
+## Getting started
+The easiest way to get started with Rapier is to:
+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`.
+ 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.
+
+## Resources and discussions
+- [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).
+- [User guide](https://www.rapier.rs/docs/): Learn to use Rapier in your project by reading the official User Guides.
+- [Discord](https://discord.gg/vt9DJSW): Come chat with us, get help, suggest features, on Discord!
+- [NPM packages](https://www.npmjs.com/search?q=%40dimforge): 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](CODE_OF_CONDUCT.md)
+and our [Contribution Guidelines](CONTRIBUTING.md) before contributing or participating in
+discussions with the community.
+
+
+## Platinum sponsors
Rapier is supported by:
<p>
<a href="https://embark-studios.com">
- <img src="https://www.embark.dev/img/logo_black.png" width="301px">
+ <img src="https://www.embark.dev/img/logo_black.png" width="400px">
</a>
</p> \ No newline at end of file