aboutsummaryrefslogtreecommitdiff
path: root/book/en/src/by-example/new.md
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2020-10-13 13:14:03 +0000
committerGitHub <noreply@github.com>2020-10-13 13:14:03 +0000
commit1db5faad62c89cff19d2a94c8ce7b98bac9439ac (patch)
treeb695a3ba77a6d8e3d1b3bd9c0a1c86f947e958c2 /book/en/src/by-example/new.md
parentb8665a2f312d325a9963075614a6c406e9fe3882 (diff)
parentefe6b516fb4def3b704216362155633c0834dcc7 (diff)
Merge #392
392: device path must be absolute; clarify r=AfoHT a=dcarosone feel free to nitpick path terminology Co-authored-by: Daniel Carosone <Daniel.Carosone@gmail.com>
Diffstat (limited to 'book/en/src/by-example/new.md')
-rw-r--r--book/en/src/by-example/new.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/book/en/src/by-example/new.md b/book/en/src/by-example/new.md
index 866a9fa..82681bf 100644
--- a/book/en/src/by-example/new.md
+++ b/book/en/src/by-example/new.md
@@ -52,7 +52,23 @@ $ curl \
> src/main.rs
```
-That example depends on the `panic-semihosting` crate:
+The `init` example uses the `lm3s6965` device. Remember to adjust the `device`
+argument in the app macro attribute to match the path of your PAC crate, if
+different, and add peripherals or other arguments if needed. Although aliases
+can be used, this needs to be a full path (from the crate root). For many
+devices, it is common for the HAL implementation crate (aliased as `hal`) or
+Board Support crate to re-export the PAC as `pac`, leading to a pattern similar
+to the below:
+
+```rust
+use abcd123_hal as hal;
+//...
+
+#[rtic::app(device = crate::hal::pac, peripherals = true, monotonic = rtic::cyccnt::CYCCNT)]
+mod app { /*...*/ }
+```
+
+The `init` example also depends on the `panic-semihosting` crate:
``` console
$ cargo add panic-semihosting