diff options
| author | Daniel Friesel <derf@finalrewind.org> | 2019-11-17 21:23:26 +0100 |
|---|---|---|
| committer | Daniel Friesel <derf@finalrewind.org> | 2019-11-17 21:23:26 +0100 |
| commit | a066b340cc62d9ada95bbdf47f0d06c38c48859f (patch) | |
| tree | ca2e28478e3a41fa2a45b1a77998113fbb30b9c7 | |
| parent | 514d4e25c28c2abf293dadb434a3cdabfbfee91a (diff) | |
convert readme to markdown
| -rw-r--r-- | README.md (renamed from README) | 59 |
1 files changed, 39 insertions, 20 deletions
@@ -1,11 +1,11 @@ Travel::Status::DE::IRIS - Interface to IRIS based web departure monitors -------------------------------------------------------------------------- +--- <https://finalrewind.org/projects/Travel-Status-DE-IRIS/> Dependencies ------------- +--- * perl version 5.14.2 or newer * Class::Accessor @@ -28,33 +28,44 @@ not wish to build it), the following drop-in replacements are available: * Text::Levenshtein (about 10 times slower than the XS modules) To use them, run: -> sed -i 's/Text::LevenshteinXS/Text::Levenshtein::XS/g' Build.PL lib/Travel/Status/DE/IRIS/Stations.pm + +``` +sed -i 's/Text::LevenshteinXS/Text::Levenshtein::XS/g' Build.PL lib/Travel/Status/DE/IRIS/Stations.pm +``` + or -> sed -i 's/Text::LevenshteinXS/Text::Levenshtein/g' Build.PL lib/Travel/Status/DE/IRIS/Stations.pm + +``` +sed -i 's/Text::LevenshteinXS/Text::Levenshtein/g' Build.PL lib/Travel/Status/DE/IRIS/Stations.pm +``` Installation ------------- +--- From a release tarball: -* perl Build.PL -* ./Build -* sudo ./Build install +``` +perl Build.PL +./Build +sudo ./Build install +``` From git: -* perl Build.PL -* ./Build -* ./Build manifest -* sudo ./Build install +``` +perl Build.PL +./Build +./Build manifest +sudo ./Build install +``` 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'. +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. @@ -68,17 +79,25 @@ Automatic method, e.g. to incorporate changes from Open Data sources: Manual method: -* run ./json2csv in the share directory +* run `./json2csv` in the share directory * modify stations.csv automatically or manually (e.g. with LibreOffice Calc) -* run ./csv2json in the share directory +* 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 [open a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) 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` + +``` +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` + +``` +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. |