diff options
| -rw-r--r-- | README.md | 13 | 
1 files changed, 8 insertions, 5 deletions
| @@ -2,18 +2,21 @@ Fractal Gen  ==========  This is a tiny program which will output a binary [PGM](https://wikipedia.org/wiki/Netpbm_format#PGM_example) format square image of a mandelbrot or burning ship set. -Just invoke it like  -	./mbrot-gen 1000 100 2 > image.pgm +Syntax +------ -For a 1000x1000 point image of a mandelbrot set using 100 iterations and an exponent of 2. +    ./mbrot-gen <size> <max_iterations> <power> [threads] > output.pgm + +You might then want to consider using a tool such as ImageMagick to then convert the (large) output file into something more sane like a PNG.  For the cliché set you'll want to keep the exponent at 2. +For more info on the exponent, read through [Wikipedia's fine article](http://wikipedia.org/wiki/Mandelbrot_set).  Notes  ----- -1. This has your CPU over a barrel. +1. By default, this has your CPU over a barrel.     It spawns as many threads as you have cores, so have fun with that. -   I'm looking at adding an option to override the number of threads. +   You can specify the number of threads you want it to (see syntax).  2. PGMs are grayscale, so you might want to tint it or apply a pallete of sort. | 
