Update readme

1 files changed, 43 insertions, 3 deletions

@@ -1,8 +1,48 @@
-lam --- a lisp in lua
+lam(n.) -- where you go when a scheme goes bad
 by C. Duckworth
 
-lam(n.) -- where you go when a scheme goes bad
+about lam
+---------
+
+lam is my little toy lisp evaluator.  written in lua!
+(no, it isn't fennel.)
+
+this is /very much/ a work in progress.
+lam uses lua 5.1 or luajit.
+it might work elsewhere, but i've not tested it on those.
+
+using lam
+---------
+
+you can set up a repl of lam to test it out:
+
+> make repl
+
+all of lua's math.* functions are available, as well as
+
+- +
+- *             (more math functions to come!)
+- null?
+- number?
+- symbol?
+- apply
+- begin
+- map
+- car
+- cdr
+- list
+
+and special forms
+
+- quote
+- define
+- lambda
+
+lam limitations
+---------------
 
-this is /very much/ a work in progress
+- lam just has numbers and operations on them
+- uh, and symbols. and lists. and lambdas and environments.
 
+---------------------------
 contributions/help WELCOME!