Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hiddewie committed Oct 20, 2024
1 parent 99f7c0c commit 3d57a42
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,21 @@ Open a pull request where you provide details about the new railway signals. Ens

*To be documented...*

## I want to visualize a new loading gauge on the map

Edit the file [`features/loading_gauge.yaml`](https://github.com/hiddewie/OpenRailwayMap-vector/edit/master/features/loading_gauge.yaml).

The file contains a list of loading gauges, each with a value (the value of the `loading_gauge` tag), a legend and a color.

Add a new entry at a certain place in the list. The value is the `loading_gauge` tag value. The `legend` will be used as a description in the legend. For example:
```yaml
loading_gauges:
- { value: 'TSI_GA', legend: 'GA', color: 'blue' }
# ...
```

Open a pull request where you provide details about the new loading gauge. Ensure the pull request contains references to documentation and places on the map where the loading gauge exists.

## I want to improve the user interface

The HTML, Javascript and CSS of the user interface are located in the [proxy](https://github.com/hiddewie/OpenRailwayMap-vector/tree/master/proxy) directory.
Expand Down

0 comments on commit 3d57a42

Please sign in to comment.