summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorcirakg <cirakg@cirakg.xyz>2026-10-21 19:58:51 +0200
committercirakg <cirakg@cirakg.xyz>2026-10-21 19:58:51 +0200
commitbd2787c29c1e37d4683247dc7cf4e754f20754ad (patch)
tree6b05e6c64a780a401c65832e0ea429691eaaa4b6 /README.md
parentf439beec17419ccbe0dc7643cc039079f15e04a0 (diff)
docs: your step-by-step guide to the on-watch tests before 1.0.0
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1045ec6..4606c05 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@ A Garmin Connect IQ watch app that shows one-time passwords (TOTP, HOTP, and opt
> - **Memory and speed:** a 100-entry import peaks at 45 % of the Forerunner 255S's memory instead of 56 %; QR mask scoring on packed rows; two job steps per tick on the 768 KB watches.
> - **Watchdog safety:** every 2D encoder now handles the largest inputs the app accepts without being stopped by the watchdog, proven by `make watchdog` at twice the normal work per event.
> - **Docs:** the [user guide](docs/USER_GUIDE.md) with the [known limitations](docs/USER_GUIDE.md#known-limitations).
+> - **Your next steps:** [docs/YOUR_STEPS.md](docs/YOUR_STEPS.md), everything left for you before 1.0.0, in order.
>
> Waiting for you: the settings spike (`make spike`, [docs/SETTINGS_SPIKE.md](docs/SETTINGS_SPIKE.md)) and the [real-watch checklist](docs/TESTING.md#real-watch-checklist) with the 0.8.0 beta. The Phase 0 research, with sources, is in [docs/FEASIBILITY.md](docs/FEASIBILITY.md); the daily workflow is in [docs/DEVELOPER_GUIDE.md](docs/DEVELOPER_GUIDE.md).
@@ -1025,6 +1026,7 @@ The simulator runs on your PC's CPU, so its timings don't represent a watch. In
| --- | --- |
| `README.md` | This plan, kept up to date as the project's overview |
| [`docs/FEASIBILITY.md`](docs/FEASIBILITY.md) | Phase 0 findings with sources |
+| `docs/YOUR_STEPS.md` | Your steps before 1.0.0: the settings spike, the on-watch tests and the results to send back |
| `docs/USER_GUIDE.md` | Install the beta, import from Aegis, add codes, PIN and locking, daily use, moving to a new watch, troubleshooting |
| `docs/DEVELOPER_GUIDE.md` | Repository layout, build, test and debug in Docker, adding a symbology or a device, coding conventions |
| `docs/SECURITY.md` | Threat model, crypto choices and parameters, record formats, known limitations, how to report issues |