From 28efd73e249d5589c4ce198d3d3b6c71426fc3fb Mon Sep 17 00:00:00 2001 From: Crozet Sébastien Date: Thu, 1 Apr 2021 14:47:20 +0200 Subject: Add ARCHITECTURE, CODE_OF_CONDUCT, CONTRIBUTING files + flesh out the README. --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index aa8853c..3ddba11 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,39 @@ ----- -## Gold sponsors +## What is Rapier? + +Rapier is a set of 2D and 3D physics engines for games, animation, and robotics. It is built in Rust +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). + +## 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:

- +

\ No newline at end of file -- cgit From 160ae1ad3dac824cd87d260d5c54bc51ee175d81 Mon Sep 17 00:00:00 2001 From: Crozet Sébastien Date: Thu, 1 Apr 2021 14:50:19 +0200 Subject: README: fix missing html tag. --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3ddba11..84b8cac 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@

Website | Documentation +

----- -- cgit From 19e43c44c80c86e23a693c723406b190c76c1208 Mon Sep 17 00:00:00 2001 From: Crozet Sébastien Date: Thu, 1 Apr 2021 14:59:25 +0200 Subject: Fix some typos and links. --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 84b8cac..341d2d9 100644 --- a/README.md +++ b/README.md @@ -35,12 +35,15 @@ ## What is Rapier? -Rapier is a set of 2D and 3D physics engines for games, animation, and robotics. It is built in Rust -by the [Dimforge](https://dimforge.com) organization. It is forever free and open-source! +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: @@ -50,7 +53,7 @@ The easiest way to get started with Rapier is to: 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 +- [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! -- cgit