about summary refs log tree commit diff stats
path: root/shell/README.md
diff options
context:
space:
mode:
authorKartik K. Agaram <vc@akkartik.com>2021-03-08 20:57:11 -0800
committerKartik K. Agaram <vc@akkartik.com>2021-03-08 20:57:11 -0800
commit0810c7b77e5a2571ce2a04b07293bcb0de54929d (patch)
tree8633883d6778ea6c338c19f226cacc45da969cd8 /shell/README.md
parentaaf2941bfeeb73c8b611d02bfe7d0d7b952c42a6 (diff)
downloadmu-0810c7b77e5a2571ce2a04b07293bcb0de54929d.tar.gz
readme for the Mu shell
Diffstat (limited to 'shell/README.md')
-rw-r--r--shell/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/shell/README.md b/shell/README.md
new file mode 100644
index 00000000..c1dee248
--- /dev/null
+++ b/shell/README.md
@@ -0,0 +1,8 @@
+### A prototype shell for the Mu computer
+
+Currently runs a tiny subset of Lisp. To build and run it from the top-level:
+
+```
+./translate shell/*.mu
+qemu-system-i386 disk.img
+```