summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorKevin Chabowski <kevin@kch42.de>2013-08-05 23:13:12 +0200
committerKevin Chabowski <kevin@kch42.de>2013-08-05 23:13:12 +0200
commit693174d1069433ff679ed26ddd92832bd7a087ec (patch)
tree9eec0501619eb6286ede1961fae134e537a39df9 /README.markdown
parent3bcc4f39f183e1f103adb1a5729a3ece90ee1f24 (diff)
downloadnebula2-693174d1069433ff679ed26ddd92832bd7a087ec.tar.gz
nebula2-693174d1069433ff679ed26ddd92832bd7a087ec.tar.bz2
nebula2-693174d1069433ff679ed26ddd92832bd7a087ec.zip
Some improvements to the README file.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown
index c44053f..495d819 100644
--- a/README.markdown
+++ b/README.markdown
@@ -10,19 +10,32 @@ nebula2 uses these libraries:
* [iniparser](https://github.com/ndevilla/iniparser) for parsing ini files (no, really!). (included as git submodule).
* [pthreads](http://en.wikipedia.org/wiki/Pthreads) for parallelism. Should ship with your Linux distribution.
+## Get the sources
+
+### Using git
+
+ git clone https://github.com/kch42/nebula2.git
+ cd nebula2
+ git submodule init
+ git submodule update
+
+### As `.tar.bz2` archive
+
+[kch42.de/progs/nebula2.tar.bz2](http://kch42.de/progs/nebula2.tar.bz2)
+
## Building
Simply run `make` in this directory.
If you have a CPU that does not support SSE2 you should remove the `-DHAVE_SSE2` part of the `SFMTFLAGS` variable in the Makefile.
-## Running / Config file
+## Usage
nebula2 needs a config file. It is an ini file. All parameters must belong to the section \[nebula2\].
### Config parameters
-* **width** — The image width.
+* **width** – The image width.
* **height** – The image heigth.
* **jobsize** – The size of a singe job (how many mandelbrot traces should be recorded during one job).
* **jobs** – The number of jobs to execute. If the image quality is not good enough, you can later increase this number and rerun nebula2. It will continue where it left, if the statefile is still there.