From abed235f6918e932020f93f5be4f358637af8144 Mon Sep 17 00:00:00 2001 From: David Phillips Date: Tue, 9 Jun 2015 15:17:58 +1200 Subject: Updated readme according to selectable thread count --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 271c185..c0b8cc5 100644 --- a/README.md +++ b/README.md @@ -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 [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. -- cgit v1.1