From 552ecd4458e24369932bc4a3dd641c4c4e3e59fc Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 22 Apr 2023 22:53:45 +0200 Subject: Promote starting a new project to it's own chapter --- book/en/src/SUMMARY.md | 2 +- book/en/src/by-example/starting_a_project.md | 17 ----------------- book/en/src/starting_a_project.md | 17 +++++++++++++++++ 3 files changed, 18 insertions(+), 18 deletions(-) delete mode 100644 book/en/src/by-example/starting_a_project.md create mode 100644 book/en/src/starting_a_project.md (limited to 'book/en') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index 8b19bf1..a500fd9 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -2,6 +2,7 @@ [Preface](./preface.md) +- [Starting a new project](./starting_a_project.md) - [RTIC by example](./by-example.md) - [The `app`](./by-example/app.md) - [Hardware tasks & `pend`](./by-example/hardware_tasks.md) @@ -11,7 +12,6 @@ - [The idle task](./by-example/app_idle.md) - [Channel based communication](./by-example/channel.md) - [Delay and Timeout](./by-example/delay.md) - - [Starting a new project](./by-example/starting_a_project.md) - [The minimal app](./by-example/app_minimal.md) - [Tips & Tricks](./by-example/tips.md) - [Implementing Monotonic](./by-example/tips_monotonic_impl.md) diff --git a/book/en/src/by-example/starting_a_project.md b/book/en/src/by-example/starting_a_project.md deleted file mode 100644 index ae979f4..0000000 --- a/book/en/src/by-example/starting_a_project.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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 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 -- cgit v1.2.3