aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorstuebinm2022-06-10 22:05:03 +0200
committerstuebinm2022-06-10 22:22:52 +0200
commitc37d12f82eea235295c50014acd41c094b426f14 (patch)
tree82d0a1eedefb14ad9e7a968736c5a4188f3ed3d0
parent9e6186cadc60f6c39cf0a32ebf49d0be01848803 (diff)
add readme
Diffstat (limited to '')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..18b4471
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Tracktrain
+
+*experimental, don't expect things to work for now*
+
+A thing to track trains via GPS (eventually), generating real-time data for use
+in e.g. passenger information systems. Timetables are read in via GTFS.
+
+## Server
+I run a test-deployment of this at (tracktrain.stuebinm.eu)[https://tracktrain.stuebinm.eu].
+
+It self-generates an OpenAPI description of the currently implemented routes at
+(`/api`)[https://tracktrain.stuebinm.eu/debug/openapi].