From 46d99bd323c0fc1ae6fd60a1d2f7df3f3680de44 Mon Sep 17 00:00:00 2001
From: est31 <MTest31@outlook.com>
Date: Sun, 17 Jan 2016 21:07:08 +0100
Subject: [PATCH] README improvements

---
 README.md | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 4853d3b..a36b407 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
 #Leaftest
 
-Leaftest consists of a bash script that uses [minetestmapper](https://github.com/Rogier-5/minetest-mapper-cpp) to display the map on a leaflet based zoomable sloppy map. As an example, see [VanessaE survival server's map](https://daconcepts.com/vanessa/hobbies/minetest/worldmaps/Survival_World/map.html).
+Leaftest consists of a bash script that uses [minetestmapper](https://github.com/Rogier-5/minetest-mapper-cpp) to display the map on a leaflet based zoomable sloppy map.
+For an example, see [VanessaE survival server's map](https://daconcepts.com/vanessa/hobbies/minetest/worldmaps/Survival_World/map.html).
 
-The map is generated in chunks through many invocations of `minetestmapper` instead of one invocation and large file thats cropped later, so that memory requirements for all tools are unrelated to the map size.
+The map is generated through many invocations of `minetestmapper` with small chunks,
+instead of one invocation with the whole map, which gets cropped later.
+This will keep memory requirements for all tools mostly unrelated to the map size.
 
 ### Dependencies
 
@@ -26,15 +29,17 @@ To start the mapping, do:
 MAPPERDIR=dir/containing/minetestmapper ./mapper.sh path/to/world spawnx,spawny dimension
 ```
 
-The `dimension` number specifies the width and height of the map that should be rendered, centering with your spawn position. `dimension` should be a multiple of 8*256 =  2048, 6144 is a good starting value.
+Make sure that you have provided a `colors.txt` file, e.g. by putting it inside the world directory.
 
-The list of parameters passed via the invocation is fixed,
-but you can use the environment variable mechanism
-to pass further options to the mapper script:
+The `dimension` number specifies the width and height of the map that should be rendered, centering with your spawn position. `dimension` should be a multiple of `8*256 = 2048`. `6144` is a good starting value.
+
+The list of parameters passed via the invocation is fixed.
+Further options are passed to the mapper script via the
+environment variable mechanism (as observable above):
 
 * `MAPPERDIR` must point to the path that contains the minetestmapper executable
 * `MAPPERPARAMS` can be used to pass custom parameters to the `minetestmapper` invocation
-* `JOBNUM` can be used to enable parallelisation. Set it to a positive number to
+* `JOBNUM` can be set to an integer > 1 to run `JOBNUM` many processes in parallel to speed up the mapping process
 
 After mapping has finished, you can open the `www/map.html` file. If you want to publish your results, you can either symlink the `www` directory into your `/var/www` directory, or copy it. Due to usage of relative symlinks, you should use `rsync -L`, so that the copied directory doesn't contain symlinks.