summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGreg Brown <greg.brown.00@outlook.com>2025-01-21 18:28:12 +0000
committerGitHub <noreply@github.com>2025-01-21 18:28:12 +0000
commit3f4e0844880a43ae113f75711bfcb60b9f22a4dd (patch)
tree0f17a3c745acf521851ee2de8047bcec2bf15d6d /README.md
parentb7b3673bfd1cd8135ae98207dab3f2f54c27c70b (diff)
Update README.md
Add more build instructions.
Diffstat (limited to 'README.md')
-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.