aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2023-01-17 20:30:27 +0100
committerDaniel Schadt <kingdread@gmx.de>2023-01-17 20:30:27 +0100
commitf824bef0e78e51c985c2333c400c6741782db2d0 (patch)
treef84a66ba11599f5147f56e437d7100495e5c66ec
parent3e72b924b69d0bf3a7660f589838c14ae4f0f2f2 (diff)
downloadhittekaart-f824bef0e78e51c985c2333c400c6741782db2d0.tar.gz
hittekaart-f824bef0e78e51c985c2333c400c6741782db2d0.tar.bz2
hittekaart-f824bef0e78e51c985c2333c400c6741782db2d0.zip
update README
-rw-r--r--README.adoc11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.adoc b/README.adoc
index 57a7759..8636e74 100644
--- a/README.adoc
+++ b/README.adoc
@@ -51,15 +51,16 @@ files:
=== MULTITHREADING
-PNG compression takes up a big part of the heatmap generation. By default,
-`hittekaart` will parallelize this process using a sensible default, using as
-many threads as you have CPU cores.
+Heatmap generation involves some CPU intensive parts, namely the parsing of the
+GPX files and the PNG compression. Especially the latter takes up a big part of
+the heatmap generation. By default, `hittekaart` will parallelize those
+processes, by default using as many threads as you have CPU cores.
If you want to limit the number of threads that will be used, for example
because you want to run the heatmap generation in the background, use the
`--threads` option. Setting a thread count of 0 will use the default behaviour
of using all cores, while setting it to any other number will use that many
-threads.
+threads. The setting `--threads=1` effectively disables multithreading.
=== ZOOM LEVELS
@@ -212,7 +213,7 @@ https://gitlab.com/dunj3/hittekaart/-/issues or via email (see below).
== AUTHOR
-Daniel Schadt - contact me electronically with my first name (in lowercase) at
+Daniel Schadt - contact me electronically with this project's name at
kingdread.de
== COPYRIGHT