From 50c0529fd56a5f38978da04f4dec8bb29d64508d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20T=C5=AFma?= <tumic@cbox.cz>
Date: Fri, 3 Jul 2020 00:40:38 +0200
Subject: [PATCH] Create README.md

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7519ffb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# pbf2png
+PBF(MVT) tiles to PNG convertor - [QtPBFImagePlugin](https://github.com/tumic0/QtPBFImagePlugin)
+example/benchmark app. Converts a directory of Mapbox vector tiles to PNG tiles.
+
+## Build
+```shell
+qmake pbf2png.pro
+make
+```
+
+## Usage
+Use `pbf2png -h` for help. The parameters should be self-explanatory, except the
+`-M` - tile name mask parameter. It's only there because of the notoriously known
+design flaw in the Mapbox vector tiles specification - the missing zoom level
+in the tile data. To render a tile, a workaround that fetches the zoom level from
+the file name (or somewhere else) is required. The default mask(regular expression)
+is `([0-9]+).*` which should fit all common tile name schemes like $z-$x-$y.pbf.