From 0fc51718518619f48d859f3a65d67c3bf4267d44 Mon Sep 17 00:00:00 2001
From: Dustin Carlino <dabreegster@gmail.com>
Date: Fri, 19 Jul 2024 13:28:06 +0100
Subject: [PATCH] Dev docs

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 43bbef2..c0e6dec 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
 # 15-minute neighborhood tool
 
 This is an experimental rewrite of <15m.abstreet.org>. Stay tuned.
+
+## Developer docs
+
+To build and run the web app locally, `cd web; npm run wasm; npm run dev`. You need to re-run `npm run wasm` when the Rust code in `backend` changes.
+
+The GTFS data used is built from the [UK BODS](https://data.bus-data.dft.gov.uk/). After downloading and unzipping, you can build using `cd backend; cargo run --release gmd /path/to/gtfs`. The file is encoded using [geomedea](https://github.com/michaelkirk/geomedea).