jjanzen/writhing_mass_of_flesh
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated documentation

Browse source
This commit is contained in:
jacob janzen 2022-08-28 13:17:54 -05:00
parent 95055f3a2d
commit de1eab74ef
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,17 +1,22 @@
# Bubbles # Writhing Mass of Flesh
This program procedurally generates a GIF that resembles a writhing mass This program procedurally generates a GIF that resembles a writhing mass
of flesh. Originally, it was intended to be bubbles, but so it goes. 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 The easiest way to download and compile this is simply
of processing that has to happen: ```sh
``` cargo install writhing_mass_of_flesh
cargo build --release
``` ```
USAGE: Alternatively, you can clone the repository and run
```sh
cargo build --release
``` ```
bubbles --width <WIDTH> --height <HEIGHT> --frames <FRAMES> --num-cells <NUM_CELLS> --out <OUT> and the program will be `./target/release/writhing_mass_of_flesh`
USAGE:
```sh
writhing_mass_of_flesh --width <WIDTH> --height <HEIGHT> --frames <FRAMES> --num-cells <NUM_CELLS> --out <OUT>
``` ```
OPTIONS: OPTIONS: