Commit graph

113 commits

Author SHA1 Message Date
Dario Nieuwenhuis
f2c95b86e7
Merge pull request #2844 from Dygear/doc-updates
Link back to Cargo.toml section.
2024-04-26 20:28:34 +00:00
Haobo Gu
5002ff00de doc: add RMK to embassy in the wild
Signed-off-by: Haobo Gu <haobogu@outlook.com>
2024-04-25 23:50:51 +08:00
Mark Tomlin
7b47d53de2
Update sharing_peripherals.adoc
Fixed Typo.
2024-04-22 17:01:22 -04:00
Mark Tomlin
ebb3148124
Update time_keeping.adoc
Fixed Typo.
2024-04-22 17:00:44 -04:00
Joël Schulz-Ansres
79fbdb1fe0 Add USB debugging section to FAQ 2024-04-22 00:38:09 +02:00
Mark Tomlin
b03f23ab64
Update sharing_peripherals.adoc 2024-04-19 21:36:03 -04:00
Mark Tomlin
b2f7ce99d6
Update time_keeping.adoc 2024-04-19 21:35:25 -04:00
Oleksandr Kuksenko
0dcf034857
Update layer_by_layer.adoc
Fixed typo
2024-04-19 13:37:58 +03:00
James Munns
8988df9ac1
FAQ: Common STM32 stumbling blocks
Adds some commonly encountered issues.

Help wanted: if anyone has a working BDMA linker script setup, it would be good to add here.
2024-04-16 11:07:42 +02:00
Dario Nieuwenhuis
0e1208947e
Merge pull request #2741 from schmettow/patch-1
Added YLab project to "in the wild"
2024-04-04 21:44:40 +00:00
David Zwart
446965a903
Update faq.adoc 2024-04-03 22:33:21 +02:00
David Zwart
7aef047def
Update faq.adoc
github link
2024-04-03 22:32:28 +02:00
David Zwart
54be08afe4
Update faq.adoc with memory.x definition helping hand 2024-04-03 22:24:09 +02:00
schmettow
f10ee07a90
Update embassy_in_the_wild.adoc
corrected link to Ystudio project
2024-03-28 14:35:24 +01:00
schmettow
82046c4691
Added YLab project to "in the wild"
YLab uses Embassy
2024-03-26 22:26:44 +01:00
Andreas Schmidt
4c0d63ce61
docs: update broken reference in basic_application.adoc 2024-03-01 10:13:59 +01:00
Andreas Schmidt
e954d1716a
docs: update basic example references in basic_application.adoc 2024-02-29 20:27:35 +01:00
Barnaby Walters
d07a0148d7 Documented rp2040 probe-rs info bug, linked to new_project page 2024-02-28 15:48:37 +01:00
Barnaby Walters
2787164ea9 grammar fix 2024-02-28 15:15:43 +01:00
Barnaby Walters
990b44566c [docs] Added some failure modes to watch out for
* Linked to probe.rs website rather than the crates.io page
* Fixed some formatting errors (>:( grrr asciidoc)
* Added cargo add probe-rs failure mode
* Added pico-w vs pico blinky failure mode
2024-02-28 15:11:30 +01:00
James Munns
4a0b1cbadb
Update docs/modules/ROOT/pages/faq.adoc 2024-02-13 15:23:50 +01:00
Ralf
f9af0096bd FAQ add hint to embassy-time linker error to include HAL in linking 2024-02-13 15:04:47 +01:00
Ulf Lilleengen
fd9318f205
Merge pull request #2354 from AdinAck/docs-generation-1
Add Generation Repos to Docs
2024-02-09 19:33:16 +00:00
Priit Laes
cbdc49ef8d faq: embassy-time was split into three packages, update faq accordingly
I ran into this issue when I had to pull in embassy-nrf from git,
though cargo didn't complain about conflicting embassy-time links.
2024-02-09 10:15:53 +02:00
Priit Laes
6e2d54c40b faq: Nightly is not required anymore 2024-02-09 10:14:55 +02:00
Priit Laes
bb743420be faq: Fix typo 2024-02-09 10:14:34 +02:00
Ulf Lilleengen
7817c8b17c docs: fix bullet point indentation 2024-02-05 09:10:53 +01:00
Matous Hybl
4650a35661 docs: Embassy in the wild - add air quality monitoring system 2024-02-03 09:41:14 +01:00
James Munns
5e7876c800
Update docs/modules/ROOT/pages/faq.adoc 2024-01-30 12:41:46 +01:00
James Munns
f388074338 Add some comments from chat 2024-01-30 10:34:09 +01:00
Shane Snover
3c159205a7 Fix the backticks on the getting started page 2024-01-25 22:30:42 -07:00
James Munns
40e9fc36dc
Update faq.adoc
Don't suggest people disable debuginfo, and explain why
2024-01-23 12:06:28 +01:00
Adin Ackerman
b825f76c28 add extra info to stable arena usage 2024-01-16 20:00:39 -08:00
Barnaby Walters
d2d9175a1d Added manual ISR FAQ 2024-01-13 02:14:56 +01:00
Ulf Lilleengen
ff5f5021fb cleanup docs and add channel synchronization example 2024-01-10 09:52:46 +01:00
Vasil Nikolov
781e33023e add draft doc page for peripheral sharing 2024-01-10 00:49:54 +02:00
James Munns
7dec3ccca4
[FAQ]: Link to Arena configuration docs 2024-01-02 18:44:41 +01:00
Benjamin Ward
79cb62c9b4
Expand LoRa crate notes per PR review 2024-01-01 10:23:57 -05:00
Benjamin Ward
fa9cb99cb6 Update docs to reflect current LoRa crate name/location 2023-12-30 21:30:27 -05:00
Adin Ackerman
9ea7a245e9 add some generation resources, add some feature descriptions 2023-12-24 11:51:16 -08:00
Dániel Buga
cf0e5e32ad Remove Xtensa specifier 2023-12-21 14:27:58 +01:00
Ulf Lilleengen
876faa5685 docs: more docs in embassy-boot crate documentation 2023-12-13 19:00:26 +01:00
Dario Nieuwenhuis
3ef18ec133
Merge pull request #2263 from embassy-rs/jamesmunns-patch-2
Tweak FAQ size profile suggestions
2023-12-08 20:50:00 +01:00
Dario Nieuwenhuis
4e7b855b2d
Merge pull request #2265 from JuliDi/docs-best-practices
[Docs] Add best practices page
2023-12-08 20:49:45 +01:00
Dario Nieuwenhuis
3f30e87cb5
Merge pull request #2251 from JuliDi/faq-performance-tweaks
[FAQ] Add section about speed optimization
2023-12-08 19:35:32 +00:00
JuliDi
c05149e5e4
add best practices first draft 2023-12-08 13:00:21 +01:00
Ulf Lilleengen
c94a9b8d75
Merge pull request #2260 from barnabywalters/main
Added Embassy in the wild docs page with links to some projects
2023-12-08 09:55:31 +00:00
James Munns
8fa5a6b282
Tweak FAQ size profile suggestions
If we want the smallest binary, we probably want codegen-units = 1, and disable incremental builds.
2023-12-07 14:27:09 +01:00
Barnaby Walters
16e31747cc Changed example project name 2023-12-07 00:54:39 +01:00
Barnaby Walters
536e91d263 Added a step-by-step guide to starting a new embassy project
Based off an example, noting what to copy, what to change and why

Briefly summarizing how to require embassy crates via github

All steps tested and proven working at the time of writing
2023-12-06 23:51:13 +01:00