Skip to content

Commit

Permalink
Improve Contributing section in readme (streetcomplete#99)
Browse files Browse the repository at this point in the history
  • Loading branch information
riQQ authored Aug 28, 2021
1 parent 59fbc4d commit 7755a6c
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,19 @@ Every vector map tiles hoster has his own schema, so every map style is per se o

## Contributing

* Open the code in Tangram Play ([Normal map](https://tangram.city/play/?scene=https://raw.githubusercontent.com/ENT8R/streetcomplete-mapstyle/jawg/streetcomplete-light-style.yaml), [Satellite map](https://tangram.city/play/?scene=https://raw.githubusercontent.com/ENT8R/streetcomplete-mapstyle/jawg/streetcomplete-satellite-style.yaml), [Dark map](https://tangram.city/play/?scene=https://raw.githubusercontent.com/ENT8R/streetcomplete-mapstyle/jawg/streetcomplete-dark-style.yaml))
* Open the code in an editor
* StreetComplete Map Style Editor
(recommended; [Normal map](https://streetcomplete.github.io/streetcomplete-mapstyle/?provider=jawg&style=light), [Satellite map](https://streetcomplete.github.io/streetcomplete-mapstyle/?provider=jawg&style=satellite), [Dark map](https://streetcomplete.github.io/streetcomplete-mapstyle/?provider=jawg&style=dark))
Already includes a jawg.io API key
* Tangram Play ([Normal map](https://tangram.city/play/?scene=https://raw.githubusercontent.com/ENT8R/streetcomplete-mapstyle/jawg/streetcomplete-light-style.yaml), [Satellite map](https://tangram.city/play/?scene=https://raw.githubusercontent.com/ENT8R/streetcomplete-mapstyle/jawg/streetcomplete-satellite-style.yaml), [Dark map](https://tangram.city/play/?scene=https://raw.githubusercontent.com/ENT8R/streetcomplete-mapstyle/jawg/streetcomplete-dark-style.yaml))
When using jawg.io, add your API key to the field `api_key` in the `global` section
* Change or add something to the style
* Download the file after you did your work
* Make a pull request to this repository

## Useful links

* [View map & edit map style](https://streetcomplete.github.io/streetcomplete-mapstyle/?provider=jawg)
* [Tangram documentation](https://mapzen.com/documentation/tangram/)
* [Tangram Play](https://tangram.city/play/)
* [View map](https://streetcomplete.github.io/streetcomplete-mapstyle)
* [Issue #183 of StreetComplete](https://github.com/westnordost/StreetComplete/issues/183) (The reason why this repository was created)

0 comments on commit 7755a6c

Please sign in to comment.