aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar bors[bot] <26634292+bors[bot]@users.noreply.github.com> 2021-08-27 04:37:04 +0000
committerGravatar GitHub <noreply@github.com> 2021-08-27 04:37:04 +0000
commitcd37e3a72c152bbdafde4476d5dc68f121813022 (patch)
tree6cd5cdd928db1e88135d4d26cf780af886b4ede0
parent22ec841ee14cc313b1725ff6ab6de1b5706d2824 (diff)
parenteec2e9c154e421f7e12070d40a925e9e2c689986 (diff)
downloadrtic-cd37e3a72c152bbdafde4476d5dc68f121813022.tar.gz
rtic-cd37e3a72c152bbdafde4476d5dc68f121813022.tar.zst
rtic-cd37e3a72c152bbdafde4476d5dc68f121813022.zip
Merge #519
519: Update README to highlight `cortex-m` 0.6 vs 0.7 new feature r=korken89 a=jorgeig-space This is just a general README update. I will open another PR for the rust-doc text in branch 0.5.x, in case there is a new release of 0.5.x at some point. Co-authored-by: Jorge Iglesias Garcia <44316552+jorgeig-space@users.noreply.github.com> Co-authored-by: Jorgeig <jorge@jorgeig.com>
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 78b6fa86..b9bfb393 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,16 @@ Formerly known as Real-Time For the Masses.
- Applications must be written using the 2018 edition.
+### Crate `cortex-m` 0.6 vs 0.7 in RTIC 0.5.x
+
+The crate `cortex-m` 0.7 started using trait `InterruptNumber` for interrupts instead of `Nr` from `bare-metal`. In order to preserve backwards compatibility, RTIC 0.5.x will keep using `cortex-m` 0.6 by default. `cortex-m` 0.7 can be enabled using the feature `cortex-m-7` and disabling default features:
+
+```
+cortex-m-rtic = { version = "0.5.8", default-features = false, features = ["cortex-m-7"] }
+```
+
+RTIC 0.6 already uses `cortex-m` 0.7 by default.
+
## [User documentation](https://rtic.rs) - [(Development version)](https://rtic.rs/dev)
## [API reference](https://rtic.rs/stable/api/)