Skip to content

Commit

Permalink
docs(readme): Fix description of cargo feature flag
Browse files Browse the repository at this point in the history
The feature flags are not mutually exclusive anymore.
  • Loading branch information
jcornaz authored Aug 31, 2021
1 parent 3f97796 commit 7b701f0
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ heron = { version = "0.11.1", features = ["2d"] }

## Feature flags

One must choose to use either `2d` or `3d` (but not both). If none of theses two features is enabled, the `PhysicsPlugin` won't be available.
One must choose to use either `2d` or `3d`. If none of theses two features is enabled, the `PhysicsPlugin` won't be available.


* `3d` Enable simulation on the 3 axes `x`, `y`, and `z`. Incompatible with the feature `2d`.
* `2d` Enable simulation only on the first 2 axes `x` and `y`. Incompatible with the feature `3d`, therefore require to disable the default features.
* `3d` Enable simulation on the 3 axes `x`, `y`, and `z`.
* `2d` Enable simulation only on the first 2 axes `x` and `y`.
* `debug-2d` Render 2d collision shapes. Works only in 2d, support for 3d may be added later.


Expand Down

0 comments on commit 7b701f0

Please sign in to comment.