Skip to content

Conversation

@crespum
Copy link

@crespum crespum commented Jan 19, 2026

I've seen #400 PR but I went ahead and modified the docs to use the new suggested template (https://github.com/knurling-rs/app-template).

The tricky part is that the new template uses defmt, so the qemu-system-arm binary is not enough but Ferrous System's qemu-run tool is required to decode the output properly.

I'm not a big fan of third-party dependencies in the official docs, but feedback is welcome.

@crespum crespum requested a review from a team as a code owner January 19, 2026 12:06
Copy link
Member

@eldruin eldruin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds good to me, thank you!
The dependency is unfortunate but I see the convenience in using the template for a hello world.
Any objections?


Next, let's see how to run an embedded program on QEMU! This time we'll use the
`hello` example which actually does something.
`hello` example which actually does something. By default, this example uses [defmt]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`hello` example which actually does something. By default, this example uses [defmt]
`hello` example which actually does something. By default, this example uses `[defmt]`


```rust,ignore
//! Prints "Hello, world!" on the host console using semihosting
In order to read and decode the messages produced by defmt in the host, we need to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order to read and decode the messages produced by defmt in the host, we need to
In order to read and decode the messages produced by `defmt` in the host, we need to

-kernel target/thumbv7m-none-eabi/debug/hello
```

In our case, since we use defmt, the host will not be able to decode the output. Instead, we
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In our case, since we use defmt, the host will not be able to decode the output. Instead, we
In our case, since we use `defmt`, the host will not be able to decode the output. Instead, we

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants