about summary refs log tree commit diff stats
path: root/prototypes/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'prototypes/README.md')
-rw-r--r--prototypes/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/prototypes/README.md b/prototypes/README.md
new file mode 100644
index 00000000..28d3b298
--- /dev/null
+++ b/prototypes/README.md
@@ -0,0 +1,23 @@
+# Prototypes
+
+Each directory here is a series of prototypes for a single app.
+
+To build prototype #n of app X under this directory:
+
+```
+$ ./translate_mu prototypes/__X__/__n__.mu
+```
+
+Now try running it with some text file:
+
+```
+$ ./a.elf __text_file__
+```
+
+Sub-directories are prototypes with multiple files. Build them like this:
+
+```
+$ ./translate_mu prototypes/__X__/__n__/*.mu
+```
+
+Run them as before.