Skip to content

Commit 291df8b

Browse files
committed
docs: Update CONTRIBUTING for pyOCD as default deploy tool.
1 parent 09aaed1 commit 291df8b

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ For local development (without dev container):
120120
* Python 3.10+
121121
* Node.js 22+ (for husky, commitlint, lint-staged, semantic-release)
122122
* `arm-none-eabi-gcc` toolchain (for `make firmware`)
123-
* OpenOCD (for `make deploy`)
123+
* `pyocd` (for `make deploy`, installed via `pip install -e ".[flash]"`)
124+
* OpenOCD (optional, for `make deploy-openocd`)
124125
* `mpremote` (installed via `pip install -e ".[test]"`)
125126
* GitHub CLI (`gh`)
126127

@@ -192,7 +193,8 @@ The drivers are "frozen" into the MicroPython firmware for the STeaMi board. The
192193
```bash
193194
make firmware # Clone micropython-steami (if needed), link local drivers, build
194195
make firmware-update # Refresh the MicroPython clone and board-specific submodules
195-
make deploy # Flash firmware via OpenOCD
196+
make deploy # Flash firmware via pyOCD (default)
197+
make deploy-openocd # Flash firmware via OpenOCD (alternative)
196198
make run SCRIPT=lib/steami_config/examples/show_config.py # Run with live output
197199
make deploy-script SCRIPT=lib/.../calibrate_magnetometer.py # Deploy as main.py for autonomous use
198200
make run-main # Re-execute the deployed main.py

0 commit comments

Comments
 (0)