ref: 423057246e2aabcd4641bfeb9bfdd8dc03ecd488
parent: 8df87ec5c7efed4d1152019540e6f4f98459e89a
author: cancel <cancel@cancel.fm>
date: Sat Jan 4 17:27:27 EST 2020
Cleanup
--- a/README.md
+++ b/README.md
@@ -37,7 +37,7 @@
Mouse awareness can be disabled by adding the `--no-mouse` option.
-### Make
+### Build using `make`
```sh
make release # optimized build, binary placed at build/orca
@@ -47,7 +47,7 @@
The `make` wrapper will enable `--portmidi` by default. If you run the `tool` build script on its own, `--portmidi` is not enabled by default.
-### Build Script
+### Build using the `tool` build script
Run `./tool help` to see usage info. Examples:
@@ -70,10 +70,8 @@
# Same as make clean. Removes build/
```
-## Run
+## Run ORCΛ Livecoding Environment
-### Livecoding Environment (Terminal UI)
-
```
Usage: orca [options] [file]
@@ -126,7 +124,7 @@
Example: 1
```
-#### Example: build and run `orca` with MIDI output
+### Example: build and run `orca` liveocding environment with MIDI output
```sh
$ ./tool build --portmidi orca # compile orca using build script
@@ -136,7 +134,7 @@
$ build/orca --portmidi-output-device 3 # run orca with midi device 3
```
-#### Controls
+### Livecoding Environment Controls
```
┌ Controls ───────────────────────────────────────────┐
@@ -166,7 +164,7 @@
└─────────────────────────────────────────────────────┘
```
-### CLI interpreter
+## CLI interpreter
The CLI (`cli` binary) reads from a file and runs the orca simulation for 1 timestep (default) or a specified number (`-t` option) and writes the resulting state of the grid to stdout.