rtic/book/en/src/by-example/starting_a_project.md

20 lines
920 B
Markdown
Raw Normal View History

2021-09-22 13:22:45 +02:00
# Starting a new project
A recommendation when starting a RTIC project from scratch on an ARMv7-M or ARMv8-M-main MCU is to
follow RTIC's [`defmt-app-template`]. For ARMv6-M or ARMv8-M-base, check out Section 4.? of
this book for more information on hardware and implementation differences to be aware of before
starting with RTIC.
2021-09-22 13:22:45 +02:00
[`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
2021-12-18 22:37:01 +01:00
protection using [`flip-link`]. There are also a multitude of examples available provided by the community:
2021-09-22 13:22:45 +02:00
2021-12-18 22:37:01 +01:00
- [`rtic-examples`] - Multiple projects
2021-09-22 13:22:45 +02:00
- [https://github.com/kalkyl/f411-rtic](https://github.com/kalkyl/f411-rtic)
- ... More to come
[`defmt`]: https://github.com/knurling-rs/defmt/
[`flip-link`]: https://github.com/knurling-rs/flip-link/
2021-12-18 22:37:01 +01:00
[`rtic-examples`]: https://github.com/rtic-rs/rtic-examples