From 32ba6c4424bfd49e9fd4e22d43010d36c6c7e638 Mon Sep 17 00:00:00 2001 From: Andrew Brown Date: Tue, 19 Oct 2010 21:26:59 -0400 Subject: [PATCH] clarified -z option in readme --- README.rst | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 5d8e158..c9df344 100644 --- a/README.rst +++ b/README.rst @@ -138,12 +138,22 @@ Options -z ZOOM, --zoom=ZOOM The Overviewer by default will detect how many zoom levels are required - to show your entire map. This is equivilant to the dimensions of the - highest zoom level, in tiles. A zoom level of z means the highest zoom - level of your map will be 2^z by 2^z tiles. + to show your entire map. This option sets it manually. - The -z option will set the zoom level manually. This could be useful if - you have some outlier chunks causing your map to be too large. + *You do not normally need to set this option!* + + This is equivalent to setting the dimensions of the highest zoom level. It + does not actually change how the map is rendered, but rather *how much of + the map is rendered.* (Calling this option "zoom" may be a bit misleading, + I know) + + To be precise, it sets the width and height of the highest zoom level, in + tiles. A zoom level of z means the highest zoom level of your map will be + 2^z by 2^z tiles. + + This option map be useful if you have some outlier chunks causing your map + to be too large, or you want to render a smaller portion of your map, + instead of rendering everything. This will render your map with 7 zoom levels::