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.