summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCsaba Hruska <csaba.hruska@gmail.com>2018-02-03 14:17:41 +0100
committerCsaba Hruska <csaba.hruska@gmail.com>2018-02-03 14:17:41 +0100
commit12faffb143b6836c062d12b3fec5b8050c52d818 (patch)
tree83bbb7ebeb7f06abd87d420dad25f78005419599
parente91796d3cdc6304d8228483f1d41eea0f216f124 (diff)
update readme
-rw-r--r--README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/README.md b/README.md
index e7ba2765..33c4ea71 100644
--- a/README.md
+++ b/README.md
@@ -8,15 +8,23 @@ See: [Language Specification](http://lambdacube3d.com/lang-specification)
8 8
9## Installation 9## Installation
10 10
11Use `make` or use `cabal install`. 111. Install Haskell [Stack](http://www.haskellstack.org) by following it's simple [install manual](https://docs.haskellstack.org/en/stable/README/#how-to-install).
122. Checkout the this repository then run the following commands.
13```
14stack setup
15stack build
16```
173. Run the lambdacube-compiler cli: `stack exec lc -- -h`
12 18
13## Hacking notes 19## Tutorials and Examples
14 20
15If you are hacking on the compiler, you may be have a faster repl with ghci. Use the following commands: 21- [Getting started](http://lambdacube3d.com/getting-started)
22- [Workshop material](https://github.com/csabahruska/lambdacube-workshop)
16 23
17 make repl 24## Hacking notes
18 25
19or: 26If you are hacking on the compiler, run the test suite to check the changes:
20 27
21 cd test 28```
22 ghci -i../src runTests.hs 29stack exec lambdacube-compiler-test-suite
30```