Clarify Toolkit control and flashing scope #8

Merged
noah merged 2 commits from docs/readme-scope into main 2026-10-19 23:52:36 -06:00
2 changed files with 8 additions and 5 deletions
+1
View File
@@ -43,6 +43,7 @@ jobs:
else
status=$?
[ "$status" -eq 1 ]
fi
- name: Check CI change surface
if: steps.surface.outputs.surface != 'documentation'
+7 -5
View File
@@ -11,8 +11,8 @@
![license](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/license.svg)
Desktop miner discovery and monitoring. The Rust GUI uses wxWidgets through
a patched [wx-rs bridge](thirdparty/wx-rs). Firmware installation is under
development.
a patched [wx-rs bridge](thirdparty/wx-rs). In-app image flashing is disabled
while that path is reworked.
## Run locally
@@ -31,10 +31,12 @@ use the matching `scripts/build-gui-*.sh` script.
- Discover miners by CIDR or IP range with vendored [asic-rs](vendor/asic-rs).
- Show model, firmware, health, hashrate, temperatures, fans, PSU, and workers.
- Filter and sort the desktop table; inspect probes with `miner_probe`.
- Use controls supported by the selected firmware and restore supported
aftermarket firmware to stock.
Discovery is read-only. The installer and operator actions remain in the
[implementation plan](docs/IMPLEMENTATION-PLAN.md) and
[firmware matrix](docs/aftermarket-parity-roadmap.md).
Discovery is read-only. Control and restore actions change miners. Check the
selected devices before applying them. See the [implementation plan](docs/IMPLEMENTATION-PLAN.md)
and [firmware matrix](docs/aftermarket-parity-roadmap.md) for planned coverage.
## Development