summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..817db6d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# chisaigo
+
+A small LISP interpreter.
+
+### Prerequisites
+Cargo and Rust are required to build chisaigo. If you use linux or BSD, you can
+use your package manager to install them. If your distro does not provide them,
+or you use OSX or Windows, follow the instructions at
+[https://www.rust-lang.org/tools/install].
+
+### Installation
+```bash
+git clone https://git.librehumanitas.org/chisaigo.git
+cd chisaigo
+cargo run
+```