Merge #526

526: implement run-pass tests as xtasks r=korken89 a=Lotterleben

resolves https://github.com/rtic-rs/cortex-m-rtic/issues/499 .

With this PR, you should be able to run `cargo xtask --target <desired target>` or `cargo xtask --target all` locally. Of course, it also reconfigures the CI workflow to do the same.

Note that I've translated the old `Run-pass tests` verbatim for now, which means the code includes checks for a `"types"`example which doesn't exist anymore.

The examples could be collected much more nicely to prevent leftovers like this in the future, but imo that could also be achieved in a separate PR.

Co-authored-by: Lotte Steenbrink <lotte.steenbrink@ferrous-systems.com>

1 files changed, 10 insertions, 0 deletions

diff --git a/README.md b/README.md
index b9bfb39..e5baea7 100644
--- a/README.md
+++ b/README.md
@@ -86,6 +86,16 @@ New features and big changes should go through the RFC process in the
 
 [rfcs]: https://github.com/rtic-rs/rfcs
 
+## Running tests locally
+
+To check all `Run-pass tests` locally on your `thumbv6m-none-eabi` or `thumbv7m-none-eabi` target device, run
+
+```console
+$ cargo xtask --target <your target>
+#                       ˆˆˆˆˆˆˆˆˆˆˆˆ
+#                   e.g. thumbv7m-none-eabi
+```
+
 ## Acknowledgments
 
 This crate is based on the [Real-Time For the Masses language][rtfm-lang]