Add READMEHEADmaster

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..92ca280
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Traewel
+
+Turn your [Träwelling](https://traewelling.de/) train check-in data into a location history file, like what [GPSLogger](https://gpslogger.app/) records.
+
+## Building
+
+If you have [Guix](https://guix.gnu.org/) installed, you can set up a development environment easily using `guix shell -Df guix.scm`.
+
+Otherwise, you'll have to install the required Lisp packages manually.
+See `traewel.asd` for the list of dependencies.
+
+Once everything is installed, run `make` to build the `bin/traewel` executable.
+
+## Running
+
+Run the `bin/traewel` produced above, with (at least) the `-u`/`--username` and `-o`/`--output` options,
+and supply a [Träwelling API token](https://traewelling.de/settings/security/api-tokens).
+Use the `--help` option to see more options.
+
+## To-do list
+
+- break location data on stopovers (within each checkin) to handle differing speeds along the route
+- figure out how Träwelling handles timezones, e.g. in the UK