search

ianmackenzie / elm-geometry

2D/3D geometry package for Elm
Mozilla Public License 2.0
183 stars 26 forks source link

Clarify relationship with elm-units etc. #108

Open ianmackenzie opened 5 years ago

ianmackenzie commented 5 years ago

Do a pass through the docs and point out where types/modules come from other packages; may also be worth adding a section to the README like "Relationship to other packages" or similar.

ianmackenzie commented 5 years ago

See also https://github.com/ianmackenzie/elm-geometry-svg/issues/12, https://github.com/ianmackenzie/elm-3d-scene/issues/28

dimpase commented 4 years ago

Note that the "Using the package" instructions in https://package.elm-lang.org/packages/ianmackenzie/elm-geometry/latest/ don't work out of the box, as elm-units is not in direct dependencies after elm install ianmackenzie/elm-geometry mentioned just before that section.

A clarification would be great, as this is perhaps the first code using elm-geometry people might try (and get an error due to a missing dependency).

ianmackenzie commented 4 years ago

Good point! I've updated the README so that at least that is clear, but there probably still needs to be a more thorough review at some point.