Add vision to README

This commit is contained in:
lukasmartinelli 2016-10-06 07:35:10 +02:00
parent 500e6bf81f
commit b8b884ae1a
2 changed files with 52 additions and 0 deletions

View File

@ -1,11 +1,21 @@
## Vector Data Source ## Vector Data Source
*This is a work in progress towards OSM2VectorTiles v3.0*
This is the data source for the vector tile schema of OSM2VectorTiles. This is the data source for the vector tile schema of OSM2VectorTiles.
It contains the *tm2source* project and the required database schema (views, functions). It contains the *tm2source* project and the required database schema (views, functions).
The vector data sources stands as separate repository to foster collaboration with Wikipedia The vector data sources stands as separate repository to foster collaboration with Wikipedia
and make it easier to fork the style without forking OSM2VectorTiles as well. and make it easier to fork the style without forking OSM2VectorTiles as well.
## Vision
The vector tile schema will contain the necessary features for creating a basemap.
We will orient ourselves on the cartography used in the [Carto Basemaps](https://carto.com/location-data-services/basemaps/).
Additional layers can be always be mixed in later on but we think OSM2VectorTiles should become less bloated in v3.0.
![Future basemaps based on OSM2VectorTiles v3.0?](./basemap_vision.png)
## Requirements ## Requirements
This vector tile schema depends on a database containing several different data sources This vector tile schema depends on a database containing several different data sources
@ -24,3 +34,45 @@ The vector data source is using zoom level views for each layer and contains use
The PostgreSQL code can be found in `sql`. The PostgreSQL code can be found in `sql`.
*TODO: Write import container* *TODO: Write import container*
## Develop
To work on *osm2vectortiles.tm2source* we recommend using Docker.
- Install [Docker](https://docs.docker.com/engine/installation/)
- Install [Docker Compose](https://docs.docker.com/compose/install/)
### Prepare the Database
Now start up the database container.
```bash
docker-compose up -d postgres`
```
Import water from [OpenStreetMapData](http://openstreetmapdata.com/).
```bash
docker-compose run import-water
```
Import [Natural Earth](http://www.naturalearthdata.com/) data.
```bash
docker-compose run import-natural-earth
```
### Work on Schema
Run the `db-schema` container each time you modify SQL code inside `./schema`.
```bash
docker-compose run db-schema
```
To work on the *data.yml* you can start up Mapbox Studio Classic in a container
and visit `localhost:3000` and open the vector source project under `projects/osm2vectortiles.tm2source`.
```bash
docker-compose up mapbox-studio
```

BIN
basemap_vision.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 470 KiB