aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHenrik Tjäder <henrik@tjaders.com>2025-06-15 20:15:10 +0200
committerEmil Fresk <emil.fresk@gmail.com>2025-06-18 18:51:24 +0000
commit8b59ec567e7171dd2f45555d6d6558b34d60e3e4 (patch)
tree0d805445aa013fdf6315ce486d5f247ea0725a31
parentf0c5fa53312da84485ac4822a0d8d0b4f226fec1 (diff)
docs: README: Rework how to use cargo xtask
-rw-r--r--README.md21
1 files changed, 17 insertions, 4 deletions
diff --git a/README.md b/README.md
index 02ece83..a9a4ec4 100644
--- a/README.md
+++ b/README.md
@@ -75,14 +75,27 @@ New features and big changes should go through the RFC process in the
## 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
-$ cargo xtask --target <your target>
-# ˆˆˆˆˆˆˆˆˆˆˆˆ
-# e.g. thumbv7m-none-eabi
+$ cargo xtask ci
```
+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
This crate is based on the [Real-Time For the Masses language][rtfm-lang]