Merge #327

327: Small renaming fixes r=korken89 a=AfoHT



Co-authored-by: Henrik Tjäder <henrik@tjaders.com>

.github/workflows/docs.yml

@@ -46,8 +46,8 @@ jobs:
         run: |
           td=$(mktemp -d)
           cp -r target/doc $td/api
-          linkchecker $td/api/rtfm/
+          linkchecker $td/api/rtic/
-          linkchecker $td/api/cortex_m_rtfm_macros/
+          linkchecker $td/api/cortex_m_rtic_macros/
 
   mdbook:
     runs-on: ubuntu-latest

.github/workflows/publish.yml

@@ -47,7 +47,7 @@ jobs:
           cp -r target/doc $td/$latest/api
 
           # sed fixes
-          sed 's|URL|rtfm/index.html|g' redirect.html > $td/$latest/api/index.html
+          sed 's|URL|rtic/index.html|g' redirect.html > $td/$latest/api/index.html
           sed 's|URL|0.5|g' redirect.html > $td/index.html
           sed 's|URL|book/en|g' redirect.html > $td/$latest/index.html
 
@@ -65,13 +65,13 @@ jobs:
 
               mkdir -p $td/$prefix/book
               src=$(mktemp -d)
-              curl -L https://github.com/rtfm-rs/cortex-m-rtfm/archive/v${ver}.tar.gz | tar xz --strip-components 1 -C $src
+              curl -L https://github.com/rtic-rs/cortex-m-rtic/archive/v${ver}.tar.gz | tar xz --strip-components 1 -C $src
 
               pushd $src
               rm -f .cargo/config
               cargo doc || cargo doc --features timer-queue
               cp -r target/doc $td/$prefix/api
-              sed 's|URL|rtfm/index.html|g' $root/redirect.html > $td/$prefix/api/index.html
+              sed 's|URL|rtic/index.html|g' $root/redirect.html > $td/$prefix/api/index.html
               for lang in ${langs[@]}; do
                   ( cd book/$lang && mdbook build )
                   cp -r book/$lang/book $td/$prefix/book/$lang

README.md

@@ -2,6 +2,8 @@
 
 A concurrency framework for building real time systems.
 
+Formerly known as Real-Time For the Masses.
+
 ## Features
 
 - **Tasks** as the unit of concurrency [^1]. Tasks can be *event triggered*
@@ -45,12 +47,12 @@ A concurrency framework for building real time systems.
 
 ## [User documentation](https://rtic.rs)
 
-## [API reference](https://rtic.rs/0.5/api)
+## [API reference](https://rtic.rs/0.5/api/)
 
 ## Chat
 Join us and talk about RTIC in the [Matrix room][matrix-room].
 
-[matrix-room]: https://matrix.to/#/#rtic-rs:matrix.org
+[matrix-room]: https://matrix.to/#/#rtic:matrix.org
 
 ## Contributing
 New features and big changes should go through the RFC process in the [dedicated RFC repository][rfcs].
@@ -59,11 +61,11 @@ New features and big changes should go through the RFC process in the [dedicated
 
 ## Acknowledgments
 
-This crate is based on [the RTIC language][rtic-lang] created by the Embedded
+This crate is based on [the Real-Time For the Masses language][rtfm-lang] created by the Embedded
 Systems group at [Luleå University of Technology][ltu], led by [Prof. Per
 Lindgren][per].
 
-[rtic-lang]: http://www.rtic-lang.org/
+[rtfm-lang]: http://www.rtfm-lang.org/
 [ltu]: https://www.ltu.se/?l=en
 [per]: https://www.ltu.se/staff/p/pln-1.11258?l=en
 

book/en/src/preface.md

@@ -7,6 +7,8 @@
 This book contains user level documentation for the Real-Time Interrupt-driven Concurrency
 (RTIC) framework. The API reference can be found [here](../../api/).
 
+Formerly known as Real-Time For the Masses.
+
 There is a translation of this book in [Russian].
 
 [Russian]: ../ru/index.html
@@ -14,6 +16,6 @@ There is a translation of this book in [Russian].
 This is the documentation of v0.5.x of RTIC; for the documentation of version
 v0.4.x go [here](/0.4).
 
-{{#include ../../../README.md:5:44}}
+{{#include ../../../README.md:7:46}}
 
-{{#include ../../../README.md:50:}}
+{{#include ../../../README.md:52:}}