diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..3728ba6 --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,45 @@ | |||
1 | # lam -- Lisp Acdw Made | ||
2 | |||
3 | hi, i'm acdw. | ||
4 | this is my lisp. | ||
5 | |||
6 | ## about lam | ||
7 | |||
8 | lam is a little toy lisp evaluator | ||
9 | written in lua | ||
10 | that isn't fennel. | ||
11 | |||
12 | it's still very much a work-in-progress | ||
13 | while i work toward a lam 1500 release. | ||
14 | |||
15 | ## installing lam | ||
16 | |||
17 | ### dependencies | ||
18 | |||
19 | lam is built against luajit 2.0 and has only been tested on that. | ||
20 | it might work on other luae, though. | ||
21 | |||
22 | ## using lam | ||
23 | |||
24 | run `make repl` to set up a testing repl of the lam interpreter. | ||
25 | you can also run `make test` to start a lua repl | ||
26 | with all of lam's modules preloaded. | ||
27 | |||
28 | ## license | ||
29 | |||
30 | lam is licensed under a 3-clause bsd license. | ||
31 | see COPYING for details. | ||
32 | |||
33 | ## contribute | ||
34 | |||
35 | [email me][] or ping me somewhere | ||
36 | |||
37 | [email me]: mailto:acdw@acdw.net | ||
38 | |||
39 | ## thanks | ||
40 | |||
41 | thanks to peter norvig's [series on lisp interpreters][norvig] | ||
42 | and to m455 | ||
43 | and to my friends | ||
44 | |||
45 | [norvig]: https://norvig.com/lispy.html | ||