summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnson Bridges <bridges.anson@gmail.com>2025-11-17 16:44:06 -0800
committerAnson Bridges <bridges.anson@gmail.com>2025-11-17 16:44:06 -0800
commit24fe0609ae32c9a35d75b5bf89cab8d41701a28b (patch)
tree9464be22292acbf73cbdcc4ea91514815d69dbb8
parentb50ce25d4ad44e44cc8d765c6ee98a91ee5bc86b (diff)
Updated readme to be more helpfulHEADmaster
-rw-r--r--README.md15
-rw-r--r--README.txt1
2 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..75cf00f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+Bicycle routing software for Husky Hunt clues, used in ‘23 and ‘24. Repository contains a Flask-based webserver that both hosts a web interface for controlling as well as an API for the bicyclists’ phones to retrieve destination/routing information via an iOS app (not included in this repository). The routing is performed by querying an OSRM instance.
+
+Requirements:
+ - Python 3.13+
+ - Flask
+ - Numpy
+ - Scikit-learn
+ - VPS/Server to host Flask website/routing API
+ - OSRM backend (change the value of `host` in `dashboard_website/router.py`)
+ - Demo (limited points per query, not good for HH): `http://router.project-osrm.org`
+ - Local: install an OSRM instance on your server using Docker (https://hub.docker.com/r/osrm/osrm-backend/)
+
+Authors:
+ Anson Bridges
+ Garrin Shieh
diff --git a/README.txt b/README.txt
deleted file mode 100644
index c1f0f66..0000000
--- a/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-HH23 MMCH