From 24fe0609ae32c9a35d75b5bf89cab8d41701a28b Mon Sep 17 00:00:00 2001 From: Anson Bridges Date: Mon, 17 Nov 2025 16:44:06 -0800 Subject: Updated readme to be more helpful --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md (limited to 'README.md') 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 -- cgit v1.2.3