docs: README: Rework how to use cargo xtask

This commit is contained in:
Henrik Tjäder 2025-06-15 20:15:10 +02:00 committed by Emil Fresk
parent f0c5fa5331
commit 8b59ec567e

View file

@ -75,14 +75,27 @@ New features and big changes should go through the RFC process in the
## Running tests locally ## Running tests locally
To check all `Run-pass tests` locally on your `thumbv6m-none-eabi` or `thumbv7m-none-eabi` target device, run To check all `tests` locally, make sure you got QEMU (and ESP32 QEMU if so desired)
then:
```console ```console
$ cargo xtask --target <your target> $ cargo xtask ci
# ˆˆˆˆˆˆˆˆˆˆˆˆ
# e.g. thumbv7m-none-eabi
``` ```
To only format code before PR (included in `ci` above):
```console
$ cargo xtask fmt
```
Clippy lints:
```console
$ cargo xtask clippy
```
and so on. See `cargo xtask --help` for all options.
## Acknowledgments ## Acknowledgments
This crate is based on the [Real-Time For the Masses language][rtfm-lang] This crate is based on the [Real-Time For the Masses language][rtfm-lang]