diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2023-05-23 06:26:28 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-23 06:26:28 +0000 |
| commit | 62162241d4c7d82dfbb310113f7525d134cfde9b (patch) | |
| tree | 4346cbe248835eba381003d8592248102028dac5 /book/en/src/starting_a_project.md | |
| parent | 21b0d97e17922c023a3b5d8148a414d4277f7b87 (diff) | |
| parent | 9fa073f7936782bddf5d02b7b1949032e84de1bd (diff) | |
Merge #741
741: Docs 2 r=korken89 a=datdenkikniet
Working on the migration guide and other docs
TODO:
- [x] Migration guide
- [x] Hardcoded examples should link to example code that is tested (this was already done, AFAICT)
- [x] Address #699
- [x] Discuss: should we remove references to non-v2, apart from the migration guide and link to the book for v1? (Off-github conclusion: yes)
- [x] RTIC {vs,and} Embassy (important: distinction between embassy runtime & HALs)
- [x] More descriptive docs on how to implement & PR implementations of `Monotonic` to `rtic-monotonics`
Co-authored-by: datdenkikniet <jcdra1@gmail.com>
Diffstat (limited to 'book/en/src/starting_a_project.md')
| -rw-r--r-- | book/en/src/starting_a_project.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/book/en/src/starting_a_project.md b/book/en/src/starting_a_project.md new file mode 100644 index 0000000..437248f --- /dev/null +++ b/book/en/src/starting_a_project.md @@ -0,0 +1,17 @@ +# Starting a new project + +A recommendation when starting a RTIC project from scratch is to +follow RTIC's [`defmt-app-template`]. + +If you are targeting ARMv6-M or ARMv8-M-base architecture, check out the section [Target Architecture](./internals/targets.md) for more information on hardware limitations to be aware of. + +[`defmt-app-template`]: https://github.com/rtic-rs/defmt-app-template + +This will give you an RTIC application with support for RTT logging with [`defmt`] and stack overflow +protection using [`flip-link`]. There is also a multitude of examples provided by the community: + +For inspiration, you may look at the [rtic examples]. + +[`defmt`]: https://github.com/knurling-rs/defmt/ +[`flip-link`]: https://github.com/knurling-rs/flip-link/ +[rtic examples]: https://github.com/rtic-rs/rtic/tree/master/examples |
