aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Phillips <dbphillipsnz@gmail.com>2016-04-08 12:23:07 +1200
committerDavid Phillips <dbphillipsnz@gmail.com>2016-04-08 12:24:56 +1200
commit15a85144cc024a79db89bfc90cb58b4028a6f3c5 (patch)
treec43c5149d16a11ef1c8b34caeae714b2d67e3c23 /README.md
parent1d553865983b5ef73cffda7db8bf44f7d9f461f9 (diff)
downloadfractal-gen-15a85144cc024a79db89bfc90cb58b4028a6f3c5.tar.xz
Change markdown heading to hierarchical format
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 3 insertions, 6 deletions
diff --git a/README.md b/README.md
index b89a1c2..47888cd 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,8 @@
-Fractal Gen
-==========
+# 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.
-Syntax
-------
+## Syntax
./mandelbrot-gen -c size -i max_iterations [-e exponent] \
[-c cores] [-t thread_multiplier]
@@ -15,8 +13,7 @@ You might then want to consider using a tool such as ImageMagick to then convert
For the clich&eacute; 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
------
+## Notes
1. By default, this has your CPU over a barrel.
It spawns as many threads as you have cores, so have fun with that.