From 56ea48930d7e55a7b3dc8810ab1074056f702ba9 Mon Sep 17 00:00:00 2001
From: Oskari Timperi <oskari.timperi@iki.fi>
Date: Tue, 20 May 2014 08:16:31 +0300
Subject: add README.md and TODO

---
 README.md | 30 ++++++++++++++++++++++++++++++
 TODO      |  2 ++
 2 files changed, 32 insertions(+)
 create mode 100644 README.md
 create mode 100644 TODO

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3130540
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# lispish
+
+A simple LISP-like programming language made to learn a few things. The
+language was based on a tutorial [1].
+
+For now this is useful only to do basic arithmetic. :-)
+
+Features:
+
+- basic arithmetic works
+- closures
+- builtin symbols: atom, eq, define, if, lambda, quote, mod, +, -, /,
+  *, >
+- types: integer, string, symbol, list
+- REPL uses linenoise for history and line-editing
+- embedded tests
+
+To build the interpreter:
+
+    make repl
+
+To build the tests:
+
+    make test
+
+To build both of them together:
+
+    make all
+
+[1] https://github.com/kvalle/diy-lisp
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..64cff53
--- /dev/null
+++ b/TODO
@@ -0,0 +1,2 @@
+- garbage collection
+- REPL in the language itself
-- 
cgit v1.2.3