about summary refs log tree commit diff stats
path: root/linux/tile/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'linux/tile/README.md')
-rw-r--r--linux/tile/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/linux/tile/README.md b/linux/tile/README.md
new file mode 100644
index 00000000..a13f7662
--- /dev/null
+++ b/linux/tile/README.md
@@ -0,0 +1,33 @@
+A programming environment that tries to [“stop drawing dead fish”](http://worrydream.com/#!/StopDrawingDeadFish).
+
+<img alt='screenshot' src='../../html/rpn5.png' width='500px'>
+
+To run:
+
+```
+./translate_mu apps/tile/*.mu
+./a.elf screen
+```
+
+To run tests:
+
+```
+./a.elf test
+```
+
+To run a conventional REPL (for debugging):
+
+```
+./a.elf type
+```
+
+## hacking
+
+Unlike the top-level directory, this is just a prototype so far. There are no
+tests.
+
+To add a new primitive you'll need to hard-code it into the `evaluate`
+function (apps/tile/rpn.mu).
+
+There's also a second place you'll want to teach about predefined primitives:
+`bound-function?` (apps/tile/environment.mu)