From 2a065c54556fb18e16383bb6cce833e9c25b39e1 Mon Sep 17 00:00:00 2001 From: Dillon Kearns Date: Sat, 17 Apr 2021 14:34:39 -0700 Subject: [PATCH] Update instructions. --- docs/2.0-alpha-instructions.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/2.0-alpha-instructions.md b/docs/2.0-alpha-instructions.md index 561491df..019e251d 100644 --- a/docs/2.0-alpha-instructions.md +++ b/docs/2.0-alpha-instructions.md @@ -11,6 +11,16 @@ getting the documentation ready, and changing APIs wherever things appear to be Feedback and documentation improvements are very welcome. +## Installation + +The alpha isn't published on `npm`, so the two ways to set it up are by working directly in this git repository, or by pulling this repository down +as a git submodule. + +If you work directly within this repository, you can copy-paste one of the `examples/` projects and tweak that. Then you can pull in the latest code to tweak it. + +To install it as a git submodule, you can do `git submodule add https://github.com/dillonkearns/elm-pages && cd elm-pages && git checkout static-files`. +Then you need to install the NPM pacakge from the top-level project with `npm install ./elm-pages`. Then make sure you include `./elm-pages/src` in your `source-directories` in your `elm.json`. + ### Special files - `Document.elm` - defines the types for your applications view. Can expose any type called `Document msg` (must have exactly one type variable)