summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2019-11-17 21:20:55 +0100
committerDaniel Friesel <derf@finalrewind.org>2019-11-17 21:20:55 +0100
commite1828f5a18d6c8259eb8500d5206cf931301ccc0 (patch)
treedc71814db6b93fb4e552c06f55044e09154b37ce /README
parent1f7b7d9cc2f482d0375ca4993decae0f371c8129 (diff)
README: Add station list management howto
Diffstat (limited to 'README')
-rw-r--r--README30
1 files changed, 30 insertions, 0 deletions
diff --git a/README b/README
index e1f2d72..1b59c04 100644
--- a/README
+++ b/README
@@ -52,3 +52,33 @@ See also the Module::Build documentation.
You can then run 'man Travel::Status::DE::IRIS'.
This distribution also ships the script 'db-iris', see 'man db-iris'.
+
+Managing stations
+-----------------
+
+Travel::Status::DE::IRIS needs a list of train stations to operate, which is
+located in `share/stations.json`. There are two recommended editing methods.
+
+Automatic method, e.g. to incorporate changes from Open Data sources:
+
+* modify stations.json with a script in any JSON-aware language you like
+* run ./json2json in the share diretcory. This transforms stations.json into
+ its canonical format, which simplifies tracking of changes and reduces diff
+ size
+
+Manual method:
+
+* run ./json2csv in the share directory
+* modify stations.csv automatically or manually (e.g. with LibreOffice Calc)
+* run ./csv2json in the share directory
+
+If the changes you made are suitable for inclusion in Travel::Status::DE::IRIS,
+please open a pull request afterwards.
+
+Please only include stations which are usable with DB IRIS, that is, which have
+both DS100 and UIC numbers. If
+`curl -s https://iris.noncd.db.de/iris-tts/timetable/station/UICNUMBER`
+and
+`curl -s https://iris.noncd.db.de/iris-tts/timetable/station/DS100`
+return a `<station>` element with "name", "eva" and "ds100" attributes, you're
+good to go.