Browse Source

Added README

main
Unbewohnte 3 years ago
parent
commit
9b2fc9616b
  1. 23
      README.md

23
README.md

@ -0,0 +1,23 @@
# mandelplot
### Generate mandelbrot set with specified dimensions, a couple of palettes included !
## Usage
mandelplot [OPTIONS]
OPTIONS:
- `-d, --image_dimensions <image_dimensions>` => Set image dimensions (WIDTHxHEIGHT) [default: 7680x4320]
- `-h, --help` => Print help information
- `-i, --max_iter <max_iter>` => Specify maximum amount of iterations to decide whether the point escapes to infinity or not [default: 1000]
- `-n, --image_name <image_name>` => Set output image filename [default: mandelbrot]
- `-p, --palette <palette>` => Specify bulb color (light, dark) [default: light]
- `-V, --version` => Print version information
## TODO:
- generate image in parallel
Loading…
Cancel
Save