add readme

1 files changed, 26 insertions, 0 deletions

diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..3892f01
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,26 @@
+lisk
+----
+
+an educational lisp interpreter written in haskell
+
+
+build and run
+-------------
+
+nix:
+  
+  cabal2nix . > default.nix
+  nix-build release.nix
+  ./result/bin/lisk
+
+
+cabal:
+
+  cabal run
+
+todo
+----
+
+* use Control.Monad.Except from mtl to handle errors
+* implement property based testing with quickcheck, look
+  under tests/Properties.hs