aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2023-03-25 18:27:14 +0100
committerDaniel Schadt <kingdread@gmx.de>2023-03-25 18:27:14 +0100
commitd7e199d6afe736af36f0ec90f9843dc0fc9cc767 (patch)
tree4156226ea8d568084296c49a513d6e4e393bdb78
parentc83bcd29dc7ab2943344c18ef59a469969ff1bbb (diff)
downloadhittekaart-d7e199d6afe736af36f0ec90f9843dc0fc9cc767.tar.gz
hittekaart-d7e199d6afe736af36f0ec90f9843dc0fc9cc767.tar.bz2
hittekaart-d7e199d6afe736af36f0ec90f9843dc0fc9cc767.zip
update README
-rw-r--r--README.adoc24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
index 9c673d9..b628a68 100644
--- a/README.adoc
+++ b/README.adoc
@@ -167,6 +167,22 @@ If you don't need the tiles in separate files, you can use the SQLite output
mode. For the same data as above, the SQLite database would be 73 MiB in size.
====
+=== DIFFERENT OVERLAYS
+
+By default, `hittekaart` generates a heatmap. However, it does also support
+different modes:
+
+tilehunter::
+ In this mode, a tile that is touched by at least one input track is marked
+ as green. The goal is to get as big of a filled square as possible. The
+ difference to *marktile* (see below) is that the markings operate on a
+ fixed zoom level.
+
+marktile::
+ In this mode, tiles that contain points are marked. The difference to
+ *tilehunter* is that the marking doesn't scale and always operates on the
+ map zoom level.
+
== OPTIONS
The following options are supported:
@@ -193,6 +209,14 @@ The following options are supported:
separate PNG file. In this case, `-o` can be used to set the location of
the SQLite database. The schema is described above.
+`-m MODE`, `--mode=MODE`::
+ Sets the overlay generation mode (heatmap, marktile, tilehunter). See
+ section DIFFERENT OVERLAYS for more information.
+
+`--tilehunter-zoom=ZOOM`::
+ Only effective in the tilehunter mode. Sets the zoom level at which the
+ tiles are marked.
+
== EXAMPLE
You can generate a heatmap and serve it locally with the following commands: