Poorly document command line mode

Signed-off-by: Richard Palethorpe <richiejp@f-m.fm>
gfxprim · May 25, 2021 · 65bc49e · 65bc49e
1 parent 181b0f7
commit 65bc49e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/210r-256x256.png b/210r-256x256.png
diff --git a/README.md b/README.md
@@ -11,3 +11,16 @@ Presently it implements a nearest neighbor one dimensional cellular
 automata and the reversible variants of each rule. The implementation
 is described on
 [richiejp.com/1d-reversible-automata](https://richiejp.com/1d-reversible-automata).
+
+## Command Line
+
+If the command line switch `-f <file path>` is specified then
+`automata` will save an image to `<file path>` and exit. For example:
+
+```sh
+$ ./automata -w 4 -h 256 -i "Shell Example" -f ./210r-256x256.png -r 210 -e
+```
+
+Produces
+
+![Rule 210r](210r-256x256.png)