aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan Tuomi <jans.tuomi@gmail.com>2022-12-05 14:19:12 +0200
committerJan Tuomi <jans.tuomi@gmail.com>2022-12-05 14:21:53 +0200
commit4002b8988c799a904ef1f359d4267ef4ad80cba3 (patch)
treedbb67560f3a44c57df4b0e960861f60605ceb45f /README.md
parentbba047ae945ae7d7899d6e2c1610923bcedb0442 (diff)
Rename project to Milch
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index fa1fec0..f3e2486 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,10 @@
-# lang
+# MILCH: [M]y functional language [I]nspired by [L]isp, [C]lojure, and [H]askell
+
+## Summary
+
+`MILCH` (or `Milch`, or `milch`) is a interpreted, dynamically typed functional programming language that has some Lisp-inspired syntax and Haskell-inspired semantics. Milch is german for 🥛.
+
+I'm developing this language by myself as a hobby, and the spec is going to change all the time. Some features documented here might not yet be implemented.
Check out the language spec
[spec.md](spec.md)
@@ -6,6 +12,13 @@ Check out the language spec
Check out the TODO
[todo.md](todo.md)
+## Usage
+
+Install a Haskell toolchain with Stack and GHC. Run
+
+ stack run -- -h
+
+to see the help text.
## Author