diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -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 |