mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-02 00:14:33 +01:00
67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
# Starting a new project
|
|
|
|
Now that you have learned about the main features of the RTFM framework you can
|
|
try it out on your hardware by following these instructions.
|
|
|
|
1. Instantiate the [`cortex-m-quickstart`] template.
|
|
|
|
[`cortex-m-quickstart`]: https://github.com/rust-embedded/cortex-m-quickstart#cortex-m-quickstart
|
|
|
|
``` console
|
|
$ # for example using `cargo-generate`
|
|
$ cargo generate \
|
|
--git https://github.com/rust-embedded/cortex-m-quickstart \
|
|
--name app
|
|
|
|
$ # follow the rest of the instructions
|
|
```
|
|
|
|
2. Add a device crate that was generated using [`svd2rust`] **v0.14.x**, or a
|
|
board support crate that depends on one such device crate as a dependency.
|
|
Make sure that the `rt` feature of the crate is enabled.
|
|
|
|
[`svd2rust`]: https://crates.io/crates/svd2rust
|
|
|
|
In this example, I'll use the [`lm3s6965`] device crate. This device crate
|
|
doesn't have an `rt` Cargo feature; that feature is always enabled.
|
|
|
|
[`lm3s6965`]: https://crates.io/crates/lm3s6965
|
|
|
|
This device crate provides a linker script with the memory layout of the target
|
|
device so `memory.x` and `build.rs` need to be removed.
|
|
|
|
``` console
|
|
$ cargo add lm3s6965 --vers 0.1.3
|
|
|
|
$ rm memory.x build.rs
|
|
```
|
|
|
|
3. Add the `cortex-m-rtfm` crate as a dependency and, if you need it, enable the
|
|
`timer-queue` feature.
|
|
|
|
``` console
|
|
$ cargo add cortex-m-rtfm --allow-prerelease --upgrade=none
|
|
```
|
|
|
|
4. Write your RTFM application.
|
|
|
|
Here I'll use the `init` example from the `cortex-m-rtfm` crate.
|
|
|
|
``` console
|
|
$ curl \
|
|
-L https://github.com/japaric/cortex-m-rtfm/raw/v0.4.0-beta.1/examples/init.rs \
|
|
> src/main.rs
|
|
```
|
|
|
|
That example depends on the `panic-semihosting` crate:
|
|
|
|
``` console
|
|
$ cargo add panic-semihosting
|
|
```
|
|
|
|
5. Build it, flash it and run it.
|
|
|
|
``` console
|
|
$ # NOTE: I have uncommented the `runner` option in `.cargo/config`
|
|
$ cargo run
|
|
{{#include ../../../ci/expected/init.run}}```
|