aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjacob janzen <53062115+JacobJanzen@users.noreply.github.com>2022-08-28 13:07:59 -0500
committerGitHub <noreply@github.com>2022-08-28 13:07:59 -0500
commit4553739fadb9287b6b43ddba9b32788b509a7417 (patch)
tree3309427508348eeb14b4348773e3ce462b7a08bb /README.md
parente9c219042bde7c1e2eb6f5be8cbe9f9407d88d46 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8a5efb8..3ab1193 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,18 @@
# Bubbles
-Creates a procedurally generated image that sort of looks like bubbles
+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:
+```
+cargo build --release
+```
USAGE:
- ```
+```
bubbles --width <WIDTH> --height <HEIGHT> --frames <FRAMES> --num-cells <NUM_CELLS> --out <OUT>
- ```
+```
OPTIONS:
```