aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuchen Pei <id@ypei.org>2023-06-17 16:06:53 +1000
committerYuchen Pei <id@ypei.org>2023-06-17 16:06:53 +1000
commit0562f2dfb38f69222bb73665a33d6f20adb76bfb (patch)
tree2871a047b7a66b58f34bd13ea2c9218273a5d5a3
parent0d02b6801144397671cb95cd122718f099a61c8f (diff)
More instructions in READMEHEADmaster
-rw-r--r--.gitignore2
-rw-r--r--README.org31
2 files changed, 31 insertions, 2 deletions
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
<https://www.ptv.vic.gov.au/footer/data-and-reporting/datasets/ptv-timetable-api/ptv-timetable-api-faqs/>
on how to get one.