aboutsummaryrefslogtreecommitdiff
path: root/book/en/src/starting_a_project.md
diff options
context:
space:
mode:
authordatdenkikniet <jcdra1@gmail.com>2023-04-22 22:53:45 +0200
committerdatdenkikniet <jcdra1@gmail.com>2023-05-11 19:20:58 +0200
commit552ecd4458e24369932bc4a3dd641c4c4e3e59fc (patch)
tree3e13ff56a137be089bcc5bc893763ac86cda4ffd /book/en/src/starting_a_project.md
parenta14d24007ae6391121dc493782b900d6edb7d992 (diff)
Promote starting a new project to it's own chapter
Diffstat (limited to 'book/en/src/starting_a_project.md')
-rw-r--r--book/en/src/starting_a_project.md17
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..ae979f4
--- /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