aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan Tuomi <jans.tuomi@gmail.com>2022-12-08 13:25:03 +0200
committerJan Tuomi <jans.tuomi@gmail.com>2022-12-08 13:25:03 +0200
commit172bd50e5a585992c2eaed756999d72617c3d2fb (patch)
tree791150b1345779ccb39df1994e39f17074cd9c20 /README.md
parent34a0e2ac24bc0b2ac7d98124e54eb2a2d1635d83 (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.md b/README.md
index f3e2486..056ef96 100644
--- a/README.md
+++ b/README.md
@@ -12,14 +12,21 @@ Check out the language spec
Check out the TODO
[todo.md](todo.md)
-## Usage
+## Building
Install a Haskell toolchain with Stack and GHC. Run
- stack run -- -h
+ stack build
+ stack install
+
+to build and install the `milch` binary in your `PATH`.
+
+Then, run
+
+ milch -h
to see the help text.
## Author
-Jan Tuomi <jans.tuomi@gmail.com>
+Jan Tuomi <<jans.tuomi@gmail.com>>