aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorstuebinm2022-07-02 00:16:02 +0200
committerstuebinm2022-07-02 00:35:34 +0200
commit6c25964c0165530e7db6650eea79cbac99031353 (patch)
tree2b821e5e07320c211a8af0e70974cbbe6defef9e /README.md
parent6b4e8ba88f35538d62bb78b9872bc298178cf96d (diff)
gtfs realtime proof of concept
this adds a package for protobuf stuff, generated via hprotoc. Seems to work kinda fine? (the generated API is horrible though, will have to write some wrappers for that)
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 18b4471..ef4764d 100644
--- a/README.md
+++ b/README.md
@@ -10,3 +10,15 @@ I run a test-deployment of this at (tracktrain.stuebinm.eu)[https://tracktrain.s
It self-generates an OpenAPI description of the currently implemented routes at
(`/api`)[https://tracktrain.stuebinm.eu/debug/openapi].
+
+
+
+## Packages & Modules
+
+This project is split into a few haskell packages:
+ - the tracktrain executable in `app/`, handling startup & config
+ - the tracktrain library implementing the business logic in `lib/`
+ - the gtfs realtime library (generated with `hprotoc` from the gtfs realtime
+ proto file, along with a very little glue code in `Servant.GTFS.Realtime`)
+ in `gtfs/`
+ - that's it for now, but there'll probably be more