Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve README #254

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 51 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ The `line-colors.csv` contains several columns:
- `hafasLineId`: identifies the HAFAS line - you can get this by requesting a departure for the line from HAFAS (i.e. using [db-rest playground](https://petstore.swagger.io/?url=https%3A%2F%2Fv6.db.transport.rest%2F.well-known%2Fservice-desc%0A))
- `backgroundColor`: Color-Hexcode for the display background color
- `textColor`: Color-Hexcode for the text color
- `borderColor` Color-Hexcode for the border of the shape
- `shape`: Specifies the shape of the icon --> see examples below
- `rectangle`: Just a rectangle
- `pill`: Rectangle with completely rounded corners
- `rectangle-rounded-corner`: Rectangle with rounded corners
- `trapezoid`
- `hexagon` (not yet supported)
- `trapezoid` A trapezoid shape with a broad top and a narrow bottom side
- `hexagon` A pill with pointy tips
- `wikidataQid`: Wikidata QID for the line (if available, can be empty)

## Contributing
Expand Down Expand Up @@ -54,20 +55,22 @@ Please keep the PR's small. If possible, create a small PR for each operator. <b

## Examples

### Go-Ahead Bayern GmbH, RE72
### Die Länderbahn GmbH DLB, RE72

<img src="examples/gaby-re72.png" alt="RE72" width="100">
<img src="examples/alex-dlb-re23.png" alt="RE 23" width="100">
<br>

- `shortOperatorName`: gaby
- `lineName`: RE72
- `hafasOperatorCode`: go-ahead-bayern-gmbh
- `hafasLineId`: re-72
- `backgroundColor`: #ef7c00
- `textColor`: #ffffff
- `shortOperatorName`: alex-dlb
- `lineName`: RE 23
- `hafasOperatorCode`: alex-die-landerbahn-gmbh-dlb
- `hafasLineId`: re23
- `backgroundColor`: #ffffff
- `textColor`: #006666
- `borderColor` #006666
- `shape`: rectangle
- `wikidataQid` Q130542294

Entry: `gaby,RE72,go-ahead-bayern-gmbh,re-72,#ef7c00,#ffffff,rectangle`
Entry: `alex-dlb,RE 23,alex-die-landerbahn-gmbh-dlb,re23,#ffffff,#006666,#006666,rectangle,Q130542294`

### DB Regio AG S-Bahn München, S7
<img src="examples/sbm-s7.png" alt="S7" width="100">
Expand All @@ -79,11 +82,13 @@ Entry: `gaby,RE72,go-ahead-bayern-gmbh,re-72,#ef7c00,#ffffff,rectangle`
- `hafasLineId`: 4-800725-7
- `backgroundColor`: #8a372f
- `textColor`: #ffffff
- `borderColor` *does not apply*
- `shape`: pill
- `wikidataQid` *not available*

Entry: `mvv-db-sbm,S7,db-regio-ag-s-bahn-munchen,4-800725-7,#8a372f,#ffffff,pill`
Entry: `mvv-db-sbm,S7,db-regio-ag-s-bahn-munchen,4-800725-7,#8a372f,#ffffff,,pill,`

### KVV: Albtal-Verkehrs-Gesellschaft mbH
### KVV: Albtal-Verkehrs-Gesellschaft mbH, S1

<img src="examples/kvv-s1.png" alt="S1" width="100">
<br>
Expand All @@ -94,14 +99,42 @@ Entry: `mvv-db-sbm,S7,db-regio-ag-s-bahn-munchen,4-800725-7,#8a372f,#ffffff,pill
- `hafasLineId`: 4-a6s8-8
- `backgroundColor`: #6e692a
- `textColor`: #ffffff
- `borderColor` *does not apply*
- `shape`: rectangle-rounded-corner (a pill with less rounded corners)
- `wikidataQid` *not available*

Entry: `kvv-avg,S8,albtal-verkehrs-gesellschaft-mbh,4-a6s8-8,#6e692a,#ffffff,,rectangle-rounded-corner,`

### Other shapes:
### HVV: Hadag, 62

#### Trapezoid
<img src="examples/hvv-62.png" alt="62" width="100">
<br>

- `shortOperatorName`: hvv-had
- `lineName`: 62
- `hafasOperatorCode`: *not available*
- `hafasLineId`: 6-hvvhad-62
- `backgroundColor`: #009bb6
- `textColor`: #ffffff
- `borderColor` *does not apply*
- `shape`: trapezoid (a shape with a broad top and a narrow bottom side)
- `wikidataQid` *not available*

<img src="examples/hvv-64.png" alt="64" width="100">
Entry: `hvv-had,62,,6-hvvhad-62,#009bb6,#ffffff,,trapezoid,`

#### Hexagon
#### HVV: Hamburger Hochbahn AG, X35

<img src="examples/hvv-x35.png" alt="62" width="100">
<br>

- `shortOperatorName`: hvv-hha
- `lineName`: X35
- `hafasOperatorCode`: *not available*
- `hafasLineId`: 5-hvvhha-x35
- `backgroundColor`: #eb452e
- `textColor`: #ffffff
- `borderColor` *does not apply*
- `shape`: hexagon (a pill with pointy tips)
- `wikidataQid` *not available*

<img src="examples/hvv-112.png" alt="112" width="100">
Entry: `hvv-hha,X35,,5-hvvhha-x35,#eb452e,#ffffff,,hexagon,`
Binary file added examples/alex-dlb-re23.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed examples/gaby-re72.png
Binary file not shown.
Binary file removed examples/hvv-112.png
Binary file not shown.
Binary file added examples/hvv-62.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed examples/hvv-64.png
Binary file not shown.
Binary file added examples/hvv-x35.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading