From 1c576c2dc10f54944b1bb996d0569a4df9ff44e0 Mon Sep 17 00:00:00 2001 From: Brandon Liu Date: Sat, 28 Jan 2023 02:44:54 +0800 Subject: [PATCH] Add a few PMTiles details to README; regenerate man page (#58) * Add details on pmtiles input/output to a few parts of the README. [#57] * regenerate man page [#57] --- README.md | 7 ++++--- man/tippecanoe.1 | 15 ++++++--------- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0c4739c6..e4c3b743 100644 --- a/README.md +++ b/README.md @@ -284,7 +284,7 @@ If your input is formatted as newline-delimited GeoJSON, use `-P` to make input ### Output tileset - * `-o` _file_`.mbtiles` or `--output=`_file_`.mbtiles`: Name the output file. + * `-o` _file_`.mbtiles`, _file_`.pmtiles` or `--output=`_file_`.mbtiles`: Name the output file. * `-e` _directory_ or `--output-to-directory`=_directory_: Write tiles to the specified *directory* instead of to an mbtiles file. * `-f` or `--force`: Delete the mbtiles file if it already exists instead of giving an error * `-F` or `--allow-existing`: Proceed (without deleting existing data) if the metadata or tiles table already exists @@ -742,7 +742,7 @@ Tile-join is a tool for copying and merging vector mbtiles files and for joining new attributes from a CSV file to existing features in them. It reads the tiles from an -existing .mbtiles file or a directory of tiles, matches them against the +existing .mbtiles file, .pmtiles file, or a directory of tiles, matches them against the records of the CSV (if one is specified), and writes out a new tileset. If you specify multiple source mbtiles files or source directories of tiles, @@ -754,7 +754,7 @@ The options are: ### Output tileset - * `-o` *out.mbtiles* or `--output=`*out.mbtiles*: Write the new tiles to the specified .mbtiles file. + * `-o` *out.mbtiles*, *out.pmtiles* or `--output=`*out.mbtiles*: Write the new tiles to the specified .mbtiles file. * `-e` *directory* or `--output-to-directory=`*directory*: Write the new tiles to the specified directory instead of to an mbtiles file. * `-f` or `--force`: Remove *out.mbtiles* if it already exists. @@ -866,6 +866,7 @@ The `tippecanoe-decode` utility turns vector mbtiles back to GeoJSON. You can us on an entire file: tippecanoe-decode file.mbtiles + tippecanoe-decode file.pmtiles or on an individual tile: diff --git a/man/tippecanoe.1 b/man/tippecanoe.1 index 7858d3ca..8910fcbc 100644 --- a/man/tippecanoe.1 +++ b/man/tippecanoe.1 @@ -3,13 +3,9 @@ Builds vector tilesets \[la]https://github.com/mapbox/vector-tile-spec/\[ra] from large (or small) collections of GeoJSON \[la]http://geojson.org/\[ra], FlatGeobuf \[la]https://github.com/flatgeobuf/flatgeobuf\[ra], or CSV \[la]https://en.wikipedia.org/wiki/Comma-separated_values\[ra] features, like these \[la]MADE_WITH.md\[ra]\&. .PP -This intends to be an actively maintained fork of tippecanoe \[la]https://github.com/mapbox/tippecanoe\[ra] originally developed by Erica Fischer \[la]https://github.com/e-n-f\[ra] at Mapbox. Version 2.0.0 is equivalent to 1.36.0 \[la]https://github.com/mapbox/tippecanoe/tree/1.36.0\[ra] in the original repository. Thank you Mapbox and Erica for an incredible tool! +This is the official home of Tippecanoe, developed and actively maintained by Erica Fischer \[la]https://github.com/e-n-f\[ra] at Felt \[la]https://felt.com\[ra]\&. .PP -Key features of this fork include: -.RS -.IP \(bu 2 -Support for FlatGeobuf \[la]https://github.com/flatgeobuf/flatgeobuf\[ra] input which is more compact and 5\-10x faster than GeoJsonSeq input. -.RE +Version 2.0.0 is equivalent to 1.36.0 \[la]https://github.com/mapbox/tippecanoe/tree/1.36.0\[ra] in the original repository. Thank you Mapbox for the many years of early support. .SH Intent .PP The goal of Tippecanoe is to enable making a scale\-independent view of your data, @@ -327,7 +323,7 @@ If your input is formatted as newline\-delimited GeoJSON, use \fB\fC\-P\fR to ma .SS Output tileset .RS .IP \(bu 2 -\fB\fC\-o\fR \fIfile\fP\fB\fC\&.mbtiles\fR or \fB\fC\-\-output=\fR\fIfile\fP\fB\fC\&.mbtiles\fR: Name the output file. +\fB\fC\-o\fR \fIfile\fP\fB\fC\&.mbtiles\fR, \fIfile\fP\fB\fC\&.pmtiles\fR or \fB\fC\-\-output=\fR\fIfile\fP\fB\fC\&.mbtiles\fR: Name the output file. .IP \(bu 2 \fB\fC\-e\fR \fIdirectory\fP or \fB\fC\-\-output\-to\-directory\fR=\fIdirectory\fP: Write tiles to the specified \fIdirectory\fP instead of to an mbtiles file. .IP \(bu 2 @@ -939,7 +935,7 @@ Tile\-join is a tool for copying and merging vector mbtiles files and for joining new attributes from a CSV file to existing features in them. .PP It reads the tiles from an -existing .mbtiles file or a directory of tiles, matches them against the +existing .mbtiles file, .pmtiles file, or a directory of tiles, matches them against the records of the CSV (if one is specified), and writes out a new tileset. .PP If you specify multiple source mbtiles files or source directories of tiles, @@ -951,7 +947,7 @@ The options are: .SS Output tileset .RS .IP \(bu 2 -\fB\fC\-o\fR \fIout.mbtiles\fP or \fB\fC\-\-output=\fR\fIout.mbtiles\fP: Write the new tiles to the specified .mbtiles file. +\fB\fC\-o\fR \fIout.mbtiles\fP, \fIout.pmtiles\fP or \fB\fC\-\-output=\fR\fIout.mbtiles\fP: Write the new tiles to the specified .mbtiles file. .IP \(bu 2 \fB\fC\-e\fR \fIdirectory\fP or \fB\fC\-\-output\-to\-directory=\fR\fIdirectory\fP: Write the new tiles to the specified directory instead of to an mbtiles file. .IP \(bu 2 @@ -1095,6 +1091,7 @@ on an entire file: .RS .nf tippecanoe\-decode file.mbtiles +tippecanoe\-decode file.pmtiles .fi .RE .PP