From 9bf32dc30c40c70898dd21d42051f71dfa10cb1e Mon Sep 17 00:00:00 2001 From: Harted Date: Sun, 30 Aug 2026 21:02:25 +0200 Subject: [PATCH] docs: the hardware specs no longer wait for you They stopped for someone to pick the COM port. They find the board by USB vendor ID now and skip themselves when none is attached, so the sentence about having the hardware in front of you was the wrong way round: it is unattended, and the board being there is what decides. The testing section also grew the three platform rounds and `verify`, which is what a contributor runs before pushing. --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0dec5cb..8f4a891 100644 --- a/README.md +++ b/README.md @@ -213,6 +213,20 @@ yarn test:watch yarn test:e2e ``` +**Run everything this platform can:** + +```bash +yarn test:all:mac +yarn test:all:windows +yarn test:all:linux +``` + +Lint, typecheck, unit tests, both e2e modes, the screenshots and the scan +measurement, plus what only that platform has: the hardware specs on macOS and +Linux, and the port 502 modal on Linux, which is the one step that waits for a +person. `yarn verify` is the shorter one to run before pushing: lint, typecheck, +unit tests and e2e. + **Run E2E tests against a packaged build:** ```bash @@ -239,9 +253,9 @@ yarn test:e2e:hardware ``` These are left out of the normal runs. They talk to an Arduino running -`tools/arduino/iem3000.ino` over a serial port and pause partway through so you -can pick the COM port, so they only make sense with the hardware in front of -you. +`tools/arduino/iem3000.ino` over a serial port, and they find the board by its +USB vendor ID rather than asking, so the run is unattended and skips itself when +no board is attached. ### Build