aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4360aa4..9a54d36 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,14 @@
# reploy
-A redo of deployment of R3 sites.
+A redo of deployment of the R3 sites (cards for now).
+
+## How to use this
+
+- install haskell platform (e.g. with https://www.haskell.org/ghcup/)
+- `cabal run site -- --help` shows options
+- `cabal run site` builds a demo site
+- `cabal install` produces and installs an executable `site` into the cabal
+ path (you can use it as a program directly)
+
+