From 3c197503380ca36c2284a8640b73eb1f6ad5bc41 Mon Sep 17 00:00:00 2001
From: Mirek Kratochvil <miroslav.kratochvil@uni.lu>
Date: Tue, 13 Jun 2023 12:13:23 +0200
Subject: [PATCH] actually readme

---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

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)
+
+