about summary refs log tree commit diff stats
path: root/edit/Readme.md
diff options
context:
space:
mode:
authorKartik K. Agaram <vc@akkartik.com>2015-09-07 10:37:27 -0700
committerKartik K. Agaram <vc@akkartik.com>2015-09-07 10:37:27 -0700
commitf5465e1220d73e237c51897b7d1211ec53b0dc04 (patch)
tree939ee8e57241b8515aede8106c6420e330ace75a /edit/Readme.md
parent5ccf2653fb7d31b013f77df4e92e964e45c54f8a (diff)
downloadmu-f5465e1220d73e237c51897b7d1211ec53b0dc04.tar.gz
2177
Diffstat (limited to 'edit/Readme.md')
-rw-r--r--edit/Readme.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/edit/Readme.md b/edit/Readme.md
new file mode 100644
index 00000000..30b27d9b
--- /dev/null
+++ b/edit/Readme.md
@@ -0,0 +1,33 @@
+Environment for learning programming using mu: http://akkartik.name/post/mu
+
+Run it from the mu directory:
+
+  ```shell
+  $ ./mu edit
+  ```
+
+This will load all the `.mu` files in this directory and then run the editor.
+Press ctrl-c to quit. Press F4 to save your work (if a lesson/ directory
+exists) and to run the contents of the sandbox editor on the right.
+
+You can also run the tests for the environment:
+
+  ```shell
+  $ ./mu test edit
+  ```
+
+You can also load the files more explicitly by enumerating them all:
+
+  ```shell
+  $  ./mu edit/*.mu
+  ```
+
+This is handy if you want to run simpler versions of the editor so you can
+stage your learning.
+
+  ```shell
+  $ ./mu edit/00[12]*.mu  # run a simple editor rather than the full environment
+  ```
+
+To see how the various 'layers' are organized, peek inside the individual
+`.mu` files.