summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4205511..6060955 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,14 @@
# Inky
See `program` for some examples.
+
+# Build Instructions
+
+1. Install `idris2` and the two libraries `collie` and `flap`.
+2. `idris2 --build`.
+
+# Running
+
+- `inky format term` is a highly-opinionated, non-customizable code formatter.
+- `inky check term` type checks an expression, assuming its type is synthesizable.
+- `inky compile term` compiles a term to Guile Scheme.