From 19e43c44c80c86e23a693c723406b190c76c1208 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Crozet=20S=C3=A9bastien?= Date: Thu, 1 Apr 2021 14:59:25 +0200 Subject: [PATCH] Fix some typos and links. --- CODE_OF_CONDUCT.md | 6 ++++-- CONTRIBUTING.md | 10 +++++----- README.md | 9 ++++++--- 3 files changed, 15 insertions(+), 10 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 13f092727..e2bdfc9ea 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -8,13 +8,13 @@ - Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer. - Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works. - We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior; we strive to be inclusive. In particular, we don't tolerate behavior that excludes people in socially marginalized groups. -- Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or any of the [Dimforge moderation team][mods@dimforge.com] immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back. +- Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or any of the [Dimforge moderation team][mods] immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back. - Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome. - Keep political and religious discussions out of the public Dimforge spaces. ## Moderation -These are the policies for upholding our community's standards of conduct. If you feel that a thread needs moderation, please contact the [Dimforge moderation team][mods@dimforge.com]. +These are the policies for upholding our community's standards of conduct. If you feel that a thread needs moderation, please contact the [Dimforge moderation team][mods]. 1. Remarks that violate the Dimforge standards of conduct, including hateful, hurtful, oppressive, or exclusionary remarks, are not allowed. (Cursing in general is discouraged, and never tolerated if targeting another user, and never in a hateful manner.) 1. Remarks that moderators find inappropriate, whether listed in the code of conduct or not, are also not allowed. @@ -32,3 +32,5 @@ And if someone takes issue with something you said or d resist the urge to be de The enforcement policies listed above apply to all official Dimforge venues; including all Dimforge Discord channels; GitHub repositories under Dimforge. _This Code of Conduct is based on the Rust Code of Conduct, available here: https://www.rust-lang.org/conduct.html_ + +[mods]: mailto:mods@dimforge.com \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c12c695b5..ee087645e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Thank you for wanting to contribute! Contribution can take many forms, including - [Donations on GitHub Sponsors](https://github.com/sponsors/dimforge). It is strongly recommended to [open an issue](https://github.com/dimforge/rapier/issues) or to discuss -with us [on Discord](discord) before fixing complicated issues, or implementing new +with us [on Discord][discord] before fixing complicated issues, or implementing new features. @@ -26,7 +26,7 @@ The Rust source code of the Rapier physics engines is available on our `rapier` - Run the 3D examples with the `parallel` and `simd-stable` features enabled: `cd all_examples3; cargo run --release --features parallel,simd-stable` 4. Once you are satisfied with your changes, submit them by [opening a Pull Request](https://github.com/dimforge/rapier/pulls) on GitHub. 5. If that Pull Request does something you need urgently, or if you think it has been forgotten, don't hesitate - to ask **@sebcrozet** directly [on Discord](discord) for a review. + to ask **@sebcrozet** directly [on Discord][discord] for a review. 6. Iterate with the reviewer until the PR gets merged. ## Contributing to the user-guide [rapier](https://rapier.rs) @@ -44,7 +44,7 @@ If you would like to fix it yourself, here is the procedure: The default local address is http://localhost:3000 . 4. Once you are satisfied with your changes, submit them by [opening a Pull Request](https://github.com/dimforge/rapier.rs/pulls) on GitHub. 5. If that Pull Request does something you need urgently, or if you think it has been forgotten, don't hesitate - to ask **@sebcrozet** directly [on Discord](discord) for a review. + to ask **@sebcrozet** directly [on Discord][discord] for a review. 6. Iterate with the reviewer until the PR gets merged. ## Contributing to the JavaScript/TypeScript bindings @@ -66,10 +66,10 @@ changes you may: - To test your changes, go back to the repository's root directory, and do: `cd testbed3d; npm install; npm link ../rapier3d/pkg; npm run start`. This will open the 3D examples on your browser. - Our build system for these JS bindings is still a bit messy right now. If you have any trouble, don't - hesitate to contact us [on Discord](discord). + hesitate to contact us [on Discord][discord]. 4. Once you are satisfied with your changes, submit them by [opening a Pull Request](https://github.com/dimforge/rapier.js/pulls) on GitHub. 5. If that Pull Request does something you need urgently, or if you think it has been forgotten, don't hesitate - to ask **@sebcrozet** directly [on Discord](discord) for a review. + to ask **@sebcrozet** directly [on Discord][discord] for a review. 6. Iterate with the reviewer until the PR gets merged. [discord]: https://discord.gg/vt9DJSW \ No newline at end of file diff --git a/README.md b/README.md index 84b8caca1..341d2d9da 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!