From 1fc87ce8585cf0ceb820c03a4e8560d36a3fcc91 Mon Sep 17 00:00:00 2001 From: Ian Mackenzie Date: Thu, 5 Nov 2020 16:07:23 -0500 Subject: [PATCH] Mention installation of elm-units in README See #108 --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b753332a..fb8eaf42 100644 --- a/README.md +++ b/README.md @@ -230,13 +230,19 @@ points that have different units or are defined in different coordinate systems. ## Installation Assuming you have [installed Elm](https://guide.elm-lang.org/install.html) and -started a new project, you can install `elm-geometry` by running +started a new project, you'll want to run ```text elm install ianmackenzie/elm-geometry +elm install ianmackenzie/elm-units ``` -in a command prompt inside your project directory. +in a command prompt inside your project directory. Note that even though +`elm-units` is a dependency of `elm-geometry`, you'll still need to explicitly +install it so that you can import modules like [`Quantity`](https://package.elm-lang.org/packages/ianmackenzie/elm-units/latest/Quantity) +and [`Length`](https://package.elm-lang.org/packages/ianmackenzie/elm-units/latest/Length) +in your own code (which will be needed in basically any code that uses +`elm-geometry`.) ## Using the package @@ -256,7 +262,7 @@ example, to calculate the distance between two 2D points, you would import the module Main exposing (main) import Html exposing (Html) -import Length +import Length -- from elm-units, see 'Installation' import Point2d main : Html msg