From 12faffb143b6836c062d12b3fec5b8050c52d818 Mon Sep 17 00:00:00 2001 From: Csaba Hruska Date: Sat, 3 Feb 2018 14:17:41 +0100 Subject: update readme --- README.md | 22 +++++++++++++++------- 1 file 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) ## Installation -Use `make` or use `cabal install`. +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). +2. Checkout the this repository then run the following commands. +``` +stack setup +stack build +``` +3. Run the lambdacube-compiler cli: `stack exec lc -- -h` -## Hacking notes +## Tutorials and Examples -If you are hacking on the compiler, you may be have a faster repl with ghci. Use the following commands: +- [Getting started](http://lambdacube3d.com/getting-started) +- [Workshop material](https://github.com/csabahruska/lambdacube-workshop) - make repl +## Hacking notes -or: +If you are hacking on the compiler, run the test suite to check the changes: - cd test - ghci -i../src runTests.hs +``` +stack exec lambdacube-compiler-test-suite +``` -- cgit v1.2.3