Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme with current CLI help results #15

Merged
merged 3 commits into from
Feb 11, 2024
Merged

Update readme with current CLI help results #15

merged 3 commits into from
Feb 11, 2024

Conversation

roblabs
Copy link
Contributor

@roblabs roblabs commented Feb 9, 2024

This PR updates README with what the CLI currently is reporting back to the user. The Swift ArgumentParser is highlighted so that users can know that there is decent CLI help via mvt help <subcommand>.

  1. Update readme with current CLI help results
  2. Add example of mvt info

Sample mvt info for the .pbf stored in ~/Tests/

Name               | Features | Points | LineStrings | Polygons | Unknown | Version
--------------------+----------+--------+-------------+----------+---------+--------
admin              | 0        | 0      | 0           | 0        | 0       | 2      
aeroway            | 0        | 0      | 0           | 0        | 0       | 2      
airport_label      | 0        | 0      | 0           | 0        | 0       | 2      
area_label         | 55       | 55     | 0           | 0        | 0       | 2      
barrier_line       | 4219     | 0      | 4219        | 0        | 0       | 2      
bridge             | 14       | 0      | 14          | 0        | 0       | 2      
building           | 5414     | 0      | 0           | 5414     | 0       | 2      
building_label     | 413      | 413    | 0           | 0        | 0       | 2      
country_label      | 0        | 0      | 0           | 0        | 0       | 2      
country_label_line | 0        | 0      | 0           | 0        | 0       | 2      
landuse            | 206      | 0      | 0           | 206      | 0       | 2      
landuse_overlay    | 4        | 0      | 0           | 4        | 0       | 2      
marine_label       | 0        | 0      | 0           | 0        | 0       | 2      
place_label        | 1        | 1      | 0           | 0        | 0       | 2      
rail_station_label | 2        | 2      | 0           | 0        | 0       | 2      
road               | 502      | 1      | 497         | 4        | 0       | 2      
road_label         | 309      | 0      | 309         | 0        | 0       | 2      
state_label        | 0        | 0      | 0           | 0        | 0       | 2      
tunnel             | 2        | 0      | 2           | 0        | 0       | 2      
water              | 18       | 0      | 0           | 18       | 0       | 2      
water_label        | 1        | 1      | 0           | 0        | 0       | 2      
waterway           | 71       | 0      | 71          | 0        | 0       | 2      
waterway_label     | 7        | 0      | 7           | 0        | 0       | 2      

@roblabs
Copy link
Contributor Author

roblabs commented Feb 9, 2024

mvt info

Use mvt info on a vector tile from MapLibre World.

mvt info https://demotiles.maplibre.org/tiles/2/2/1.pbf

Result

Name      | Features | Points | LineStrings | Polygons | Unknown | Version
----------+----------+--------+-------------+----------+---------+--------
centroids | 104      | 104    | 0           | 0        | 0       | 2      
countries | 113      | 0      | 0           | 113      | 0       | 2      
geolines  | 4        | 0      | 4           | 0        | 0       | 2    

MapLibre vector tile at zoom 2, with an extent showing Norway to India.

@trasch
Copy link
Contributor

trasch commented Feb 9, 2024

Thank you, @roblabs ! Any documentation update is very much appreciated!

I wonder if I miss something, because I can't see the example output in the diff, only here in the PR? Would be a nice info, but I would probably then move the command line part a bit further down below the source code (and add an index on top?)

@roblabs
Copy link
Contributor Author

roblabs commented Feb 9, 2024

@trasch — based on your feedback on #14 & #15, I have updated the README in this branch. Can you review and merge if you approve?

🎉

@roblabs roblabs mentioned this pull request Feb 9, 2024
@trasch trasch added the documentation Improvements or additions to documentation label Feb 11, 2024
@trasch trasch merged commit 6ef3f74 into Outdooractive:main Feb 11, 2024
1 check passed
@roblabs roblabs deleted the update_readme branch February 11, 2024 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants