cerxes/openmaptiles
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Minor docs enhancement. (#1481)

Browse Source 
Update docs, links, and comments.
This commit is contained in:
Tomas Pohanka 2023-01-30 14:04:47 +01:00 committed by GitHub
parent 5e9b7c475d
commit 624cf7a8a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE.md
View File

@ -1,4 +1,4 @@
Copyright (c) 2022, MapTiler.com & OpenMapTiles contributors. Copyright (c) 2023, MapTiler.com & OpenMapTiles contributors.
All rights reserved. All rights reserved.
The vector tile schema has been developed by Klokan Technologies GmbH and The vector tile schema has been developed by Klokan Technologies GmbH and

2
Makefile
View File

@ -166,7 +166,7 @@ TPORT := $(or $(TPORT),$(shell (. .env; echo $${TPORT})),7)
define HELP_MESSAGE define HELP_MESSAGE
============================================================================== ==============================================================================
OpenMapTiles https://github.com/openmaptiles/openmaptiles OpenMapTiles https://github.com/openmaptiles/openmaptiles
Hints for testing areas Hints for testing areas
make list-geofabrik # list actual geofabrik OSM extracts for download -> <<your-area>> make list-geofabrik # list actual geofabrik OSM extracts for download -> <<your-area>>

6
QUICKSTART.md
View File

@ -2,7 +2,7 @@
### Req: ### Req:
* CPU: AMD64 ( = Intel 64 bit) * CPU: AMD64 ( = Intel 64 bit)
* The base docker debian images are x86_64 based, so the ARM,MIPS currently not supported! * The base docker debian images are x86_64 based, so the ARM, MIPS currently not supported!
* Operating system * Operating system
* Linux is suggested * Linux is suggested
* The development and the testing platform is Linux. * The development and the testing platform is Linux.
@ -423,9 +423,11 @@ Hints for testing areas
Hints for designers: Hints for designers:
make start-maputnik # start Maputnik Editor + dynamic tile server [ see http://localhost:8088 ] make start-maputnik # start Maputnik Editor + dynamic tile server [ see http://localhost:8088 ]
make stop-maputnik # stop Maputnik Editor + dynamic tile server
make start-postserve # start dynamic tile server [ see http://localhost:8090 ] make start-postserve # start dynamic tile server [ see http://localhost:8090 ]
make stop-postserve # stop dynamic tile server make stop-postserve # stop dynamic tile server
make start-tileserver # start maptiler/tileserver-gl [ see http://localhost:8080 ] make start-tileserver # start maptiler/tileserver-gl [ see http://localhost:8080 ]
make stop-tileserver # stop maptiler/tileserver-gl
Hints for developers: Hints for developers:
make # build source code make # build source code
@ -435,6 +437,7 @@ Hints for developers:
make generate-qa # statistics for a given layer's field make generate-qa # statistics for a given layer's field
make generate-tiles-pg # generate vector tiles based on .env settings using PostGIS ST_MVT() make generate-tiles-pg # generate vector tiles based on .env settings using PostGIS ST_MVT()
make generate-tiles # generate vector tiles based on .env settings using Mapnik (obsolete) make generate-tiles # generate vector tiles based on .env settings using Mapnik (obsolete)
make generate-changed-tiles # Generate tiles changed by import-diff
make test-sql # run unit tests on the OpenMapTiles SQL schema make test-sql # run unit tests on the OpenMapTiles SQL schema
cat .env # list PG database and MIN_ZOOM and MAX_ZOOM information cat .env # list PG database and MIN_ZOOM and MAX_ZOOM information
cat quickstart.log # transcript of the last ./quickstart.sh run cat quickstart.log # transcript of the last ./quickstart.sh run
@ -449,6 +452,7 @@ Hints for downloading & importing data:
make download-bbbike area=Amsterdam # download OSM data from bbbike.org and create config file make download-bbbike area=Amsterdam # download OSM data from bbbike.org and create config file
make import-data # Import data from OpenStreetMapData, Natural Earth and OSM Lake Labels. make import-data # Import data from OpenStreetMapData, Natural Earth and OSM Lake Labels.
make import-osm # Import OSM data with the mapping rules from build/mapping.yaml make import-osm # Import OSM data with the mapping rules from build/mapping.yaml
make import-diff # Import OSM updates from data/changes.osc.gz
make import-wikidata # Import labels from Wikidata make import-wikidata # Import labels from Wikidata
make import-sql # Import layers (run this after modifying layer SQL) make import-sql # Import layers (run this after modifying layer SQL)

8
README.md
View File

@ -1,4 +1,4 @@
## OpenMapTiles [![Build Status](https://github.com/openmaptiles/openmaptiles/workflows/OMT_CI/badge.svg?branch=master)](https://github.com/openmaptiles/openmaptiles/actions) ## OpenMapTiles [![Build Status](https://github.com/openmaptiles/openmaptiles/workflows/OpenMapTiles%20Integrity%20CI/badge.svg?branch=master)](https://github.com/openmaptiles/openmaptiles/actions)
OpenMapTiles is an extensible and open tile schema based on the OpenStreetMap. This project is used to generate vector tiles for online zoomable maps. OpenMapTiles is about creating a beautiful basemaps with general layers containing topographic information. More information [openmaptiles.org](https://openmaptiles.org/) and [maptiler.com/data/](https://www.maptiler.com/data/). OpenMapTiles is an extensible and open tile schema based on the OpenStreetMap. This project is used to generate vector tiles for online zoomable maps. OpenMapTiles is about creating a beautiful basemaps with general layers containing topographic information. More information [openmaptiles.org](https://openmaptiles.org/) and [maptiler.com/data/](https://www.maptiler.com/data/).
@ -88,7 +88,7 @@ make
``` ```
You can execute the following manual steps (for better understanding) You can execute the following manual steps (for better understanding)
or use the provided `quickstart.sh` script to automatically download and import given area. If area is not given, albania will be imported. or use the provided `quickstart.sh` script to automatically download and import given area. If area is not given, Albania will be imported. List of available areas `make list-geofabrik`.
``` ```
./quickstart.sh <area> ./quickstart.sh <area>
@ -114,8 +114,8 @@ Download OpenStreetMap data extracts from any source like [Geofabrik](http://dow
make download area=albania make download area=albania
``` ```
[Import OpenStreetMap data](https://github.com/openmaptiles/openmaptiles-tools/tree/master/docker/import-osm) with the mapping rules from [Import OpenStreetMap data](https://github.com/openmaptiles/openmaptiles-tools/blob/master/bin/import-osm) with the mapping rules from
`build/mapping.yaml` (which has been created by `make`). Run after any change in layers definition. `build/mapping.yaml` (which has been created by `make`). Run after any change in layers definition (any change in `mapping.yaml`).
```bash ```bash
make import-osm make import-osm

8
quickstart.sh
View File

@ -70,7 +70,7 @@ echo "==========================================================================
echo " Docker check & Download images " echo " Docker check & Download images "
echo "-------------------------------------------------------------------------------------" echo "-------------------------------------------------------------------------------------"
echo "====> : Please check the Docker and docker-compose version!" echo "====> : Please check the Docker and docker-compose version!"
echo " : We are using docker-compose v2 file format! see more at https://docs.docker.com/" echo " : We are using docker-compose v3 file format! see more at https://docs.docker.com/"
echo " : Minimum required Docker version: $MIN_DOCKER_VER+" echo " : Minimum required Docker version: $MIN_DOCKER_VER+"
echo " : Minimum required docker-compose version: $MIN_COMPOSE_VER+" echo " : Minimum required docker-compose version: $MIN_COMPOSE_VER+"
echo " : See the .travis build for the currently supported versions." echo " : See the .travis build for the currently supported versions."
@ -193,7 +193,7 @@ if [[ "$USE_PRELOADED_IMAGE" == true ]]; then
echo " : Data license: https://osmdata.openstreetmap.de/info/license.html" echo " : Data license: https://osmdata.openstreetmap.de/info/license.html"
echo " : * Natural Earth from http://www.naturalearthdata.com" echo " : * Natural Earth from http://www.naturalearthdata.com"
echo " : Terms-of-use: http://www.naturalearthdata.com/about/terms-of-use" echo " : Terms-of-use: http://www.naturalearthdata.com/about/terms-of-use"
echo " : * OpenStreetMap Lakelines data https://github.com/lukasmartinelli/osm-lakelines" echo " : * OpenStreetMap Lakelines data https://github.com/openmaptiles/osm-lakelines"
echo " :" echo " :"
echo " : Source code: https://github.com/openmaptiles/openmaptiles-tools/tree/master/docker/import-data" echo " : Source code: https://github.com/openmaptiles/openmaptiles-tools/tree/master/docker/import-data"
echo " : includes all data from the import-data image" echo " : includes all data from the import-data image"
@ -214,7 +214,7 @@ else
echo " : Data license: https://osmdata.openstreetmap.de/info/license.html" echo " : Data license: https://osmdata.openstreetmap.de/info/license.html"
echo " : * Natural Earth from http://www.naturalearthdata.com" echo " : * Natural Earth from http://www.naturalearthdata.com"
echo " : Terms-of-use: http://www.naturalearthdata.com/about/terms-of-use" echo " : Terms-of-use: http://www.naturalearthdata.com/about/terms-of-use"
echo " : * OpenStreetMap Lakelines data https://github.com/lukasmartinelli/osm-lakelines" echo " : * OpenStreetMap Lakelines data https://github.com/openmaptiles/osm-lakelines"
echo " :" echo " :"
echo " : Source code: https://github.com/openmaptiles/openmaptiles-tools/tree/master/docker/import-data" echo " : Source code: https://github.com/openmaptiles/openmaptiles-tools/tree/master/docker/import-data"
echo " : includes all data from the import-data image" echo " : includes all data from the import-data image"
@ -229,7 +229,7 @@ echo "--------------------------------------------------------------------------
echo "====> : Start importing OpenStreetMap data: ${area} -> imposm3[./build/mapping.yaml] -> PostgreSQL" echo "====> : Start importing OpenStreetMap data: ${area} -> imposm3[./build/mapping.yaml] -> PostgreSQL"
echo " : Imposm3 documentation: https://imposm.org/docs/imposm3/latest/index.html " echo " : Imposm3 documentation: https://imposm.org/docs/imposm3/latest/index.html "
echo " : Thank you Omniscale! " echo " : Thank you Omniscale! "
echo " : Source code: https://github.com/openmaptiles/openmaptiles-tools/tree/master/docker/import-osm " echo " : Source code: https://github.com/openmaptiles/openmaptiles-tools/blob/master/bin/import-osm "
echo " : The OpenstreetMap data license: https://www.openstreetmap.org/copyright (ODBL) " echo " : The OpenstreetMap data license: https://www.openstreetmap.org/copyright (ODBL) "
echo " : Thank you OpenStreetMap Contributors ! " echo " : Thank you OpenStreetMap Contributors ! "
make import-osm make import-osm