From 608075bd453edf973ea837de07920d309cf7bc44 Mon Sep 17 00:00:00 2001 From: nbschultz97 <126931519+nbschultz97@users.noreply.github.com> Date: Thu, 11 Sep 2025 15:03:31 -0600 Subject: [PATCH] docs: outline pipeline and bootstrap test --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index dfaabd6..469ccad 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,19 @@ python3 scripts/bootstrap_assets.py This will recreate the `rotor_v1.tflite` model and the required PNG drawables under `app/src/main/...`. + +## Pipeline + +1. **Asset bootstrap** – Decode the model and icons from `assets/*.b64` using the script above. Generated files land under `app/src/main/...`. +2. **Runtime wiring** – `MainActivity` creates a `DroneSignalDetector`, which launches a coroutine to fetch flight data and schedule Wi‑Fi scans. +3. **Scan handling** – `WifiScanReceiver` receives scan results. Future work will feed the TFLite model for rotor classification. + +## Testing + +Verify the asset bootstrap step restores the binaries: + +```bash +python3 scripts/bootstrap_assets.py +``` + +Each asset should report a `decoded` message. Remove the generated `app/src/main/assets` and `app/src/main/res` directories after testing to keep the repo text‑only.