aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjacob janzen <jacob.a.s.janzen@gmail.com>2022-08-28 13:17:54 -0500
committerjacob janzen <jacob.a.s.janzen@gmail.com>2022-08-28 13:17:54 -0500
commitde1eab74ef648ee09ad701e5c3714121872f36e1 (patch)
tree224fe2e8a37660514cfa242e7973ca8ebbfd5b75 /README.md
parent95055f3a2d5bc834c28d5e9e6312bcc23b271920 (diff)
updated documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/README.md b/README.md
index 3ab1193..9063384 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,22 @@
-# Bubbles
+# Writhing Mass of Flesh
This program procedurally generates a GIF that resembles a writhing mass
of flesh. Originally, it was intended to be bubbles, but so it goes.
-I strongly recommend compiling in release mode because of the large amount
-of processing that has to happen:
+The easiest way to download and compile this is simply
+```sh
+cargo install writhing_mass_of_flesh
```
+
+Alternatively, you can clone the repository and run
+```sh
cargo build --release
```
+and the program will be `./target/release/writhing_mass_of_flesh`
USAGE:
-```
- bubbles --width <WIDTH> --height <HEIGHT> --frames <FRAMES> --num-cells <NUM_CELLS> --out <OUT>
+```sh
+writhing_mass_of_flesh --width <WIDTH> --height <HEIGHT> --frames <FRAMES> --num-cells <NUM_CELLS> --out <OUT>
```
OPTIONS: