From 0562f2dfb38f69222bb73665a33d6f20adb76bfb Mon Sep 17 00:00:00 2001 From: Yuchen Pei Date: Sat, 17 Jun 2023 16:06:53 +1000 Subject: More instructions in README --- .gitignore | 2 ++ README.org | 31 +++++++++++++++++++++++++++++-- 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3e854b0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +__pycache__/ +*~ diff --git a/README.org b/README.org index fdc3ddc..db4e0c6 100644 --- a/README.org +++ b/README.org @@ -1,4 +1,31 @@ -* PTV Timetable client -- to use, you'll need a PTV Timetable Service Dev ID and API key, see +* PTV Timetable tool + :PROPERTIES: + :UPDATED: [2023-06-17 Sat 16:06] + :END: +Usage: + +#+begin_src sh +python server.py +#+end_src + +The server will be available at port 8052. + +Alternatively, to run it as a daemon, try a sample systemd service: + +#+begin_src conf +[Unit] +Description=PTV server +After=network.target + +[Service] +Type=simple +Restart=always +ExecStart=/usr/bin/python3 /opt/ptvtt/server.py + +[Install] +WantedBy=multi-user.target +#+end_src + +Note that you will need a PTV Timetable Service Dev ID and API key, see on how to get one. -- cgit v1.2.3