From 8b59ec567e7171dd2f45555d6d6558b34d60e3e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrik=20Tj=C3=A4der?= Date: Sun, 15 Jun 2025 20:15:10 +0200 Subject: [PATCH] docs: README: Rework how to use cargo xtask --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 02ece8309dc..a9a4ec4cc8d 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 -# ˆˆˆˆˆˆˆˆˆˆˆˆ -# 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]