diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 15 insertions, 7 deletions
@@ -8,15 +8,23 @@ See: [Language Specification](http://lambdacube3d.com/lang-specification) | |||
8 | 8 | ||
9 | ## Installation | 9 | ## Installation |
10 | 10 | ||
11 | Use `make` or use `cabal install`. | 11 | 1. Install Haskell [Stack](http://www.haskellstack.org) by following it's simple [install manual](https://docs.haskellstack.org/en/stable/README/#how-to-install). |
12 | 2. Checkout the this repository then run the following commands. | ||
13 | ``` | ||
14 | stack setup | ||
15 | stack build | ||
16 | ``` | ||
17 | 3. Run the lambdacube-compiler cli: `stack exec lc -- -h` | ||
12 | 18 | ||
13 | ## Hacking notes | 19 | ## Tutorials and Examples |
14 | 20 | ||
15 | If 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 | ||
19 | or: | 26 | If 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 | 29 | stack exec lambdacube-compiler-test-suite |
30 | ``` | ||