diff options
| -rw-r--r-- | Readme.md | 6 | ||||
| -rw-r--r-- | edit/Readme | 32 |
2 files changed, 35 insertions, 3 deletions
diff --git a/Readme.md b/Readme.md index 0d0bb06a..a53aa5f4 100644 --- a/Readme.md +++ b/Readme.md @@ -386,9 +386,9 @@ Screenshot: <img alt='programming environment' src='html/edit.png' width='720px'> You write recipes on the left and try them out in *sandboxes* on the right. -Hit F4 to rerun all sandboxes with the latest version of the code. More (maybe -dated) details: http://akkartik.name/post/mu. Beware, it won't save your edits -by default. But if you create a sub-directory called `lesson/` under `mu/` it +Hit F4 to rerun all sandboxes with the latest version of the code. More +details: http://akkartik.name/post/mu. Beware, it won't save your edits by +default. But if you create a sub-directory called `lesson/` under `mu/` it will. If you turn that directory into a git repo with `git init`, it will also back up each version you try out. diff --git a/edit/Readme b/edit/Readme index d32fdf66..30b27d9b 100644 --- a/edit/Readme +++ b/edit/Readme @@ -1 +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. |