diff options
| author | James Munns <[email protected]> | 2023-11-21 15:38:33 +0100 |
|---|---|---|
| committer | James Munns <[email protected]> | 2023-11-21 15:38:33 +0100 |
| commit | aedd41eac4ab2930b9dbded4b410da5f26bda1ef (patch) | |
| tree | 9d1386aef1717205fb7b46e38667abf4909a7c14 /docs | |
| parent | 766ec77ec5a9a5a0e4af32651c9eb0b6c8e93fed (diff) | |
Add FAQ with one question from chat
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/modules/ROOT/nav.adoc | 1 | ||||
| -rw-r--r-- | docs/modules/ROOT/pages/faq.adoc | 24 |
2 files changed, 25 insertions, 0 deletions
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index ee559a821..7e178df62 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc | |||
| @@ -10,3 +10,4 @@ | |||
| 10 | * xref:examples.adoc[Examples] | 10 | * xref:examples.adoc[Examples] |
| 11 | * xref:developer.adoc[Developer] | 11 | * xref:developer.adoc[Developer] |
| 12 | ** xref:developer_stm32.adoc[Developer: STM32] | 12 | ** xref:developer_stm32.adoc[Developer: STM32] |
| 13 | * xref:faq.adoc[Frequently Asked Questions] | ||
diff --git a/docs/modules/ROOT/pages/faq.adoc b/docs/modules/ROOT/pages/faq.adoc new file mode 100644 index 000000000..5b58580d0 --- /dev/null +++ b/docs/modules/ROOT/pages/faq.adoc | |||
| @@ -0,0 +1,24 @@ | |||
| 1 | = Frequently Asked Questions | ||
| 2 | |||
| 3 | These are a list of unsorted, commonly asked questions and answers. | ||
| 4 | |||
| 5 | Please feel free to add items to link:https://github.com/embassy-rs/embassy/edit/main/docs/modules/ROOT/pages/faq.adoc[this page], especially if someone in the chat answered a question for you! | ||
| 6 | |||
| 7 | == Missing main macro | ||
| 8 | |||
| 9 | If you see an error like this: | ||
| 10 | |||
| 11 | [source,rust] | ||
| 12 | --- | ||
| 13 | #[embassy_executor::main] | ||
| 14 | | ^^^^ could not find `main` in `embassy_executor` | ||
| 15 | --- | ||
| 16 | |||
| 17 | You are likely missing some features of the `embassy-executor` crate. | ||
| 18 | |||
| 19 | For Cortex-M targets, consider making sure that ALL of the following features are active in your `Cargo.toml` for the `embassy-executor` crate: | ||
| 20 | |||
| 21 | * `arch-cortex-m` | ||
| 22 | * `executor-thread` | ||
| 23 | * `nightly` | ||
| 24 | |||
