From 38118611513deced3617e3f581920125484923f0 Mon Sep 17 00:00:00 2001
From: Daniel Schadt <kingdread@gmx.de>
Date: Sat, 4 Apr 2026 19:44:07 +0200
Subject: add osmand sqlite output format (lib & cli)

---
 README.adoc | 27 ++++++++++++++++++++-------
 1 file changed, 20 insertions(+), 7 deletions(-)

(limited to 'README.adoc')

diff --git a/README.adoc b/README.adoc
index bb779b5..fa58a24 100644
--- a/README.adoc
+++ b/README.adoc
@@ -8,7 +8,7 @@ hittekaart - A GPX track heatmap generator.
 == SYNOPSIS
 
 ----
-hittekaart [--output=...] [--min-zoom=...] [--max-zoom=...] [--threads=...] [--sqlite] FILES...
+hittekaart [--output=...] [--min-zoom=...] [--max-zoom=...] [--threads=...] [--format=...] FILES...
 ----
 
 == INSTALLATION
@@ -42,8 +42,8 @@ the `--output/-o` option.
 
 In order to overcome storage overhead when saving many small files (see the tip
 and table further below), `hittekaart` can instead output a SQLite database
-with the heatmap tile data. To do so, use the `--sqlite` command line option,
-and control where the SQLite file should be placed with `--output`/`-o`.
+with the heatmap tile data. To do so, use the `--format=sqlite` command line
+option, and control where the SQLite file should be placed with `--output`/`-o`.
 
 While this does not allow you to immediately serve the tiles with a HTTP
 server, it does cut down on the wasted space on non-optimal file systems.
@@ -61,6 +61,20 @@ CREATE TABLE tiles (
 );
 ----
 
+=== OSMAND OUTPUT
+
+You can generate a file that can be read directly by
+https://osmand.net/[OsmAnd]. To do so, pass the `--format=osm-and` command line
+option, and control where the file should be placed with `--output`/`-o`.
+
+To use the map in the app, make sure to:
+
+* Give it a `.sqlitedb` extension, and
+* place it under `Android/data/net.osmand.plus/files/tiles/`.
+
+For a reference of the format, see
+https://osmand.net/docs/technical/osmand-file-formats/osmand-sqlite/.
+
 === INPUT FILES
 
 `hittekaart` expects GPX track files with the `.gpx` extension. It will parse
@@ -204,10 +218,9 @@ The following options are supported:
     when generating single files, and `tiles.sqlite` when storing the tiles in
     a SQLite database.
 
-`--sqlite`::
-    Output a single SQLite file with all tiles instead of saving each tile as a
-    separate PNG file. In this case, `-o` can be used to set the location of
-    the SQLite database. The schema is described above.
+`--format FORMAT`::
+    Sets the output format (folder, sqlite, osm-and). See the sections above on
+    OUTPUT FORMAT, SQLITE OUTPUT and OSMAND OUTPUT for more information.
 
 `-m MODE`, `--mode=MODE`::
     Sets the overlay generation mode (heatmap, marktile, tilehunter). See
-- 
cgit v1.2.3

