Skip to content

Commit

Permalink
Update contributing info
Browse files Browse the repository at this point in the history
  • Loading branch information
Phyks committed Jan 27, 2019
1 parent 10fdee5 commit f74d64f
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 0 deletions.
68 changes: 68 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
Contributing
============

## Issues

[Issues](https://github.com/Phyks/cyclosm-cartocss-style/issues) centralize
the different tasks to achieve for this style. They are labelled:

* [good first
issue](https://github.com/Phyks/cyclosm-cartocss-style/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
for any issue which should be easy to solve. These are typically good
issues to start contributing to this style.
* [new
feature](https://github.com/Phyks/cyclosm-cartocss-style/issues?q=is%3Aissue+is%3Aopen+label%3A%22new+feature%22)
for any new items to be rendered (not currently rendered).
* [enhancement](https://github.com/Phyks/cyclosm-cartocss-style/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
for already rendered items which should be reworked or improved.
* [questions](https://github.com/Phyks/cyclosm-cartocss-style/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion)
for the design choices which are unclear and should be discussed. Feel free
to take part in the discussion if you have some opinions about the
subject.

If you start working on an open issue, please comment this issue to state it
so that others will know and not work on the same thing.

When opening an issue about a specific point to improve with this style,
please include the relevant OSM tags (if applicable, typically for new
features to be rendered with the style) as well as an example OSM object (to
help checking the render is correctly added).


## Rendering locally / developping the style

### Kosmtik

The easiest way to get a local render and start developping the style is
probably using [Kosmtik](https://github.com/kosmtik/kosmtik).

First, you should follow the [INSTALL.md](INSTALL.md) guide to set up a
[PostgreSQL database with OSM
data](https://github.com/Phyks/cyclosm-cartocss-style/blob/master/INSTALL.md#openstreetmap-data)
and [install the required
fonts](https://github.com/Phyks/cyclosm-cartocss-style/blob/master/INSTALL.md#fonts).

Then, you can [install Kosmtik](https://github.com/kosmtik/kosmtik#install-or-update) as well as the `fetch-remote` plugin:

```
kosmtik plugins --install kosmtik-fetch-remote
```

_Note_: You can use a
[`localconfig.json`](https://github.com/Phyks/cyclosm-cartocss-style/blob/master/INSTALL.md#kosmtik)
file at the root of this repository to use custom PostgreSQL credentials.

You can finally run

```
kosmtik serve project.mml
```

to have a live render at `https://localhost:6789` with auto-reload when you
edit this style.

### CartoCSS

The style is written in CartoCSS. You can find some documentation on CartoCSS
[here](https://cartocss.readthedocs.io/en/latest/) or
[here](https://tilemill-project.github.io/tilemill/docs/manual/carto/).
14 changes: 14 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ Getting started
This document describes how to manually configure your system for running
CyclOSM.

## Requirements

You will need, to use this style:

* PostgreSQL
* PostGIS
* osm2pgsql

On Ubuntu/Debian, these can be installed with

```
sudo apt-get install postgresql-9.6 postgis osm2pgsql
```

## OpenStreetMap data

You need OpenStreetMap data loaded into a PostGIS database. These stylesheets
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ is available at [https://tiles.phyks.me/](https://tiles.phyks.me/).

Getting started instructions are available in [`INSTALL.md`](INSTALL.md) file.

## Contributing

Some getting started information for contributing is available in
[`CONTRIBUTING.md`](CONTRIBUTING.md) file.


## Licenses

Expand Down

0 comments on commit f74d64f

Please sign in to comment.