Update Tooling and Writing Your Own Application chapters #81

SergioGasquez · 2023-04-18T08:21:16Z

Update tooling section
Update writing your own application
Created standalone no_std repo: https://github.com/SergioGasquez/no_std-training
- Should be moved to esp-rs once it's reviewed

f-hollow

@SergioGasquez

Left some comments. Please disregard whatever is not useful or applicable.

Also, suggest reviewing the comments from the respective chapters on HackMD.

src/introduction.md

src/misc/troubleshooting.md

src/tooling/espflash.md

src/tooling/index.md

src/writing-your-own-application/generate-project-from-template.md

src/writing-your-own-application/index.md

Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>

src/writing-your-own-application/index.md

src/writing-your-own-application/generate-project/index.md

f-hollow

Some comments about the Writing Your Own Application section.

src/writing-your-own-application/generate-project/esp-template.md

f-hollow · 2023-05-10T11:34:24Z

src/writing-your-own-application/generate-project/esp-idf-template.md

+- A call to `esp_idf_sys::link_patches` function that makes sure that a few patches to the ESP-IDF which are implemented in Rust are linked to the final executable.
+- We print in our console the famous "Hello World!".
+
+## Running the Code


This section looks very similar to its counterpart in Understanding esp-template (maybe even the same).

Do you think it is better to have it in one place from the maintenance perspective? If the differences are small, maybe it is worth only covering the differences here?

Just an idea, so feel free to ignore it.

I assume you mean the "Running the Code" section, if so, the logs after flashing the project are quite different and I dont think it makes much sense to unify them

src/writing-your-own-application/generate-project/index.md

f-hollow · 2023-05-10T11:56:49Z

src/writing-your-own-application/generate-project/index.md

+
+    Using `cargo run` will compile the project, flash it, and open a serial monitor with our chip.
+
+## Using Dev Containers in the templates


I see there are some instructions in esp-rs/esp-template. I skimmed through them, and they look serious.

As an idea, it might be great to have a tutorial about using Dev Containers in VS Code with the templates. Projects with Dev Containers are usually very good for beginners.

If I missed something or if it is irrelevant, please consider it as noise.

I see there are some instructions in esp-rs/esp-template. I skimmed through them, and they look serious.

What do you mean by "they look serious"? We have some devcontainers documentation in both templates:

esp-template: https://github.com/esp-rs/esp-template/tree/main/docs

esp-idf-template: https://github.com/esp-rs/esp-idf-template/tree/master/cargo/docs

By "too serious", I mean that it looks like normal documentation as it should of course. It has links to other resources that you might choose to go through and other things that you can do.

A tutorial might be good from the perspective that you define a goal -- the result of the effort -- and lead the reader to this goal directly using only the instructions needed to achieve this goal without any additional information. The bottom line is the reader opening the document, following the steps without the need to make choices, and having a sample project completed by themselves with some desired result. Most likely, it can be a separate document or part of some book.

Again, like I said, it is just an idea off the top of my head which might be useful or might be completely irrelevant. You know the subject better, so you decide.

f-hollow

A few minor comments about the Tooling chapter.

src/tooling/text-editors-and-ides.md

src/tooling/espflash.md

src/tooling/simulating/wokwi.md

Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>

f-hollow · 2023-05-15T04:24:32Z

@SergioGasquez

Thank you for reacting to all my comments. LGTM!

* feat: ✨ Update chapter order * feat: ✨ Add tooling note * feat: ✨ Update pormpts, console outputs and dev container info * chore: 🔥 Remove hello-world chapter * chore: 🔥 Remove hello-world chapter * feat: ✨ Update information to current state of the template * feat: ✨ Update panic outputs * chore: 🔥 Remove hello-world chapter * feat: ✨ Update blinky code * feat: ✨ Update button code * feat: ✨ Update interrupt code * style: 🎨 Remove personal paths * style: 🎨 Use uppercase * feat: ✨ Update esp-idf-template chapter * feat: ✨ Update espflash chapter * feat: ✨ Update tooling intro * feat: ✨ Update VsCode chapter * chore: 🔥 Remove espmonitor * Update src/tooling/index.md Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * Update src/writing-your-own-application/index.md Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: 🎨 Update links * docs: 🎨 List possible ways of creating an app * docs: 📝 Reformat as list of instructions * docs: 📝 Remove unnecesary logs * docs: 📝 Add wokwi vs code section * docs: 🐛 Fix typo * docs: ⚡️ Update esp-template with new prompts * docs: 📝 Improve note about next chapters * docs: 📝 Update undestanding templates chapters * docs: 📝 Update Wokwi documentation * docs: 📝 Move note about cargo generate * docs: 🎨 Format prompt answers * docs: 🐛 Fix custom runner command * docs: 📝 Update espflash section * docs: 📝 Add support tables for simlating and debugging * docs: 📝 Update applications section * docs: 🐛 Fix links * docs: 🐛 Fix links * docs: 🐛 Fix links * docs: 📝 Add note about generating project with Cargo * docs: 📝 LT suggestions * docs: 📝 Update esp-idf-hal links * docs: 📝 Use listing and expand how to build/run templates+ * docs: 📝 Add link to main.rs section * docs: 📝 Remove next section paragraph * docs: 📝 Be consistent in template projects name * docs: 📝 Update section name * docs: Add comma Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: Fix typo Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: Clarify custom chips Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: 📝 Avoid listing all the supported chips * docs: ⚡️ Update debbuging support table * docs: 📝 Apply LT suggestions * docs: 📝 Apply LT suggestions * docs: ✨ Add no_std book links --------- Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>

* docs: Add Rust documentation style guide (#79) * docs: Add Rust documentation style guide (cherry picked from commit f7a307a) * Add missing extension to rust-doc-style-quide * Update the Terminology chapter * Add details on using the terms ESP-IDF and esp-idf * Add more terms * Add note on not using italics with Espressif product names * Improve guidelines on where to add link variables * Add guideine to apply monospace to image and container names * Add section on admonitions * Fix markdown formatting issues --------- Co-authored-by: Kirill Chalov <kirill.chalov@espressif.com> * Update Tooling and Writing Your Own Application chapters (#81) * feat: ✨ Update chapter order * feat: ✨ Add tooling note * feat: ✨ Update pormpts, console outputs and dev container info * chore: 🔥 Remove hello-world chapter * chore: 🔥 Remove hello-world chapter * feat: ✨ Update information to current state of the template * feat: ✨ Update panic outputs * chore: 🔥 Remove hello-world chapter * feat: ✨ Update blinky code * feat: ✨ Update button code * feat: ✨ Update interrupt code * style: 🎨 Remove personal paths * style: 🎨 Use uppercase * feat: ✨ Update esp-idf-template chapter * feat: ✨ Update espflash chapter * feat: ✨ Update tooling intro * feat: ✨ Update VsCode chapter * chore: 🔥 Remove espmonitor * Update src/tooling/index.md Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * Update src/writing-your-own-application/index.md Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: 🎨 Update links * docs: 🎨 List possible ways of creating an app * docs: 📝 Reformat as list of instructions * docs: 📝 Remove unnecesary logs * docs: 📝 Add wokwi vs code section * docs: 🐛 Fix typo * docs: ⚡️ Update esp-template with new prompts * docs: 📝 Improve note about next chapters * docs: 📝 Update undestanding templates chapters * docs: 📝 Update Wokwi documentation * docs: 📝 Move note about cargo generate * docs: 🎨 Format prompt answers * docs: 🐛 Fix custom runner command * docs: 📝 Update espflash section * docs: 📝 Add support tables for simlating and debugging * docs: 📝 Update applications section * docs: 🐛 Fix links * docs: 🐛 Fix links * docs: 🐛 Fix links * docs: 📝 Add note about generating project with Cargo * docs: 📝 LT suggestions * docs: 📝 Update esp-idf-hal links * docs: 📝 Use listing and expand how to build/run templates+ * docs: 📝 Add link to main.rs section * docs: 📝 Remove next section paragraph * docs: 📝 Be consistent in template projects name * docs: 📝 Update section name * docs: Add comma Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: Fix typo Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: Clarify custom chips Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: 📝 Avoid listing all the supported chips * docs: ⚡️ Update debbuging support table * docs: 📝 Apply LT suggestions * docs: 📝 Apply LT suggestions * docs: ✨ Add no_std book links --------- Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * docs: 📝 Update links to STD trainings * fix: Fix typo Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * fix: Format commas Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * fix: Format commas Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * fix: Clarify wording Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> * feat: ✨ Update title and add link for Rust book style guides * style: 🎨 Rename document * docs: 📝 Update the Rust Style guide links to the main repo --------- Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com> Co-authored-by: Kirill Chalov <kirill.chalov@espressif.com>

SergioGasquez added 18 commits April 13, 2023 10:41

feat: ✨ Update chapter order

dabc253

feat: ✨ Add tooling note

75d624c

feat: ✨ Update pormpts, console outputs and dev container info

330444e

chore: 🔥 Remove hello-world chapter

fb617a5

chore: 🔥 Remove hello-world chapter

61b6631

feat: ✨ Update information to current state of the template

010ae3f

feat: ✨ Update panic outputs

bead69d

chore: 🔥 Remove hello-world chapter

c43c453

feat: ✨ Update blinky code

354ddd9

feat: ✨ Update button code

ee712cf

feat: ✨ Update interrupt code

6d88414

style: 🎨 Remove personal paths

26f042c

style: 🎨 Use uppercase

3085bdc

feat: ✨ Update esp-idf-template chapter

f95cedf

feat: ✨ Update espflash chapter

837986a

feat: ✨ Update tooling intro

437cb93

feat: ✨ Update VsCode chapter

3c7dba5

chore: 🔥 Remove espmonitor

ddc556e

SergioGasquez mentioned this pull request Apr 18, 2023

Tracking the overhaul and re-organization of the book #59

Closed

6 tasks

f-hollow reviewed Apr 25, 2023

View reviewed changes

SergioGasquez changed the base branch from main to overhaul April 25, 2023 09:41

SergioGasquez and others added 9 commits April 25, 2023 15:23

Update src/tooling/index.md

18740b9

Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>

Update src/writing-your-own-application/index.md

49d7669

Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>

docs: 🎨 Update links

13ad010

docs: 🎨 List possible ways of creating an app

87ce236

docs: 📝 Reformat as list of instructions

8c66644

docs: 📝 Remove unnecesary logs

8be4451

docs: 📝 Add wokwi vs code section

151e67e

docs: 🐛 Fix typo

cc0d90c

docs: ⚡️ Update esp-template with new prompts

6bbdcc2

docs: 🐛 Fix links

b0a2abd

f-hollow reviewed May 10, 2023

View reviewed changes

src/writing-your-own-application/index.md Show resolved Hide resolved

src/writing-your-own-application/index.md Show resolved Hide resolved

docs: 📝 Add note about generating project with Cargo

165d256

f-hollow reviewed May 10, 2023

View reviewed changes

src/writing-your-own-application/generate-project/index.md Outdated Show resolved Hide resolved

SergioGasquez added 3 commits May 10, 2023 11:49

docs: 📝 LT suggestions

090223c

docs: 📝 Update esp-idf-hal links

8a51d0f

docs: 📝 Use listing and expand how to build/run templates+

a454e8b

f-hollow reviewed May 10, 2023

View reviewed changes

SergioGasquez added 4 commits May 10, 2023 15:08

docs: 📝 Add link to main.rs section

d8ca5a6

docs: 📝 Remove next section paragraph

1e376ec

docs: 📝 Be consistent in template projects name

d732967

docs: 📝 Update section name

c013a49

f-hollow reviewed May 11, 2023

View reviewed changes

SergioGasquez and others added 8 commits May 11, 2023 15:58

docs: Add comma

e3b6f12

Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>

docs: Fix typo

69a9a72

Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>

docs: Clarify custom chips

1fb0ed3

Co-authored-by: Kirill <105578077+f-hollow@users.noreply.github.com>

docs: 📝 Avoid listing all the supported chips

fbf1597

docs: ⚡️ Update debbuging support table

789e911

docs: 📝 Apply LT suggestions

b6e7250

docs: 📝 Apply LT suggestions

afa2983

docs: ✨ Add no_std book links

4f857b4

SergioGasquez marked this pull request as ready for review May 12, 2023 12:46

SergioGasquez mentioned this pull request May 16, 2023

Add references in trooubleshooting #88

Closed

SergioGasquez merged commit 00afff6 into esp-rs:overhaul May 30, 2023

SergioGasquez deleted the feature/application-chapter branch May 30, 2023 08:06

SergioGasquez mentioned this pull request Jun 6, 2023

Update code example in the Writing no_std applications section #69

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Tooling and Writing Your Own Application chapters #81

Update Tooling and Writing Your Own Application chapters #81

SergioGasquez commented Apr 18, 2023 •

edited

Loading

f-hollow left a comment

f-hollow left a comment

f-hollow May 10, 2023

SergioGasquez May 10, 2023

f-hollow May 10, 2023

SergioGasquez May 10, 2023

f-hollow May 11, 2023 •

edited

Loading

f-hollow left a comment

f-hollow commented May 15, 2023


		Using `cargo run` will compile the project, flash it, and open a serial monitor with our chip.

		## Using Dev Containers in the templates

Update Tooling and Writing Your Own Application chapters #81

Update Tooling and Writing Your Own Application chapters #81

Conversation

SergioGasquez commented Apr 18, 2023 • edited Loading

f-hollow left a comment

Choose a reason for hiding this comment

f-hollow left a comment

Choose a reason for hiding this comment

f-hollow May 10, 2023

Choose a reason for hiding this comment

SergioGasquez May 10, 2023

Choose a reason for hiding this comment

f-hollow May 10, 2023

Choose a reason for hiding this comment

SergioGasquez May 10, 2023

Choose a reason for hiding this comment

f-hollow May 11, 2023 • edited Loading

Choose a reason for hiding this comment

f-hollow left a comment

Choose a reason for hiding this comment

f-hollow commented May 15, 2023

SergioGasquez commented Apr 18, 2023 •

edited

Loading

f-hollow May 11, 2023 •

edited

Loading