Add a quickstart#93
Conversation
ithinuel
left a comment
ithinuel
left a comment
There was a problem hiding this comment.
Thank you for your contribution. That seems to be a very good idea indeed for those unused to cargo-generate and the typical -template repos.
| 1. [Connect](https://www.raspberrypi.com/documentation/microcontrollers/debug-probe.html#getting-started) | ||
| your Raspberry Pi Pico and Debug Probe to your development host. | ||
|
|
There was a problem hiding this comment.
If we want have this entry (which I don’t mind), I’d rather have it right before cargo run as this isn’t necessary to run the other steps.
There was a problem hiding this comment.
For completeness I think the step should be included somewhere, but I don't feel strongly about the exact location so this change SGTM
There was a problem hiding this comment.
Oh yes, on second reading it definitely flows better to have the step related to setting up the hardware happen right before the flashing step
| This quickstart assumes that you've got a [Raspberry Pi | ||
| Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/) (the first-generation | ||
| version containing the RP2040 MCU) as well as a [Raspberry Pi Debug | ||
| Probe](https://www.raspberrypi.com/products/debug-probe/) and will flash the Pico with | ||
| [probe-rs](https://probe.rs/). |
There was a problem hiding this comment.
Well, you could generate it using elf2uf2-rs and only have an RP2040 board and a usbcable :)
There was a problem hiding this comment.
SGTM to switch to the lowest-barrier-to-entry hardware setup if you think new users would prefer that. I think I assumed Pico / Debug Probe / probe-rs because my reading of the README suggested that that is the most common and well-supported setup
LMK which combo you want the quickstart to cover. I can add a note along the lines of "another common combo is X; see this part of the README for more details"
There was a problem hiding this comment.
lowest barrier to entry is definitely the elf2uf2 route. But it is also pretty limited. E.G. getting logs out of it would require to wire a uart of setup a usb-cdc device.
So the most convenient route to actually develop & "debug" is to have an rtt channel with probe-rs & a debug probe.
This route also unlocks the ability to step-debug if that is really needed (which I am yet to need with rust).
I don't know if a "quickstart" should aim for the lower barrier to entry, or a most convenient for developement 🤔
|
btw would you mind sharing some of those videos ? :D <3 |
|
I'm merging this as-is. If you want to do another PR moving the "connect" step to after the install steps, that's fine, but this is still better than nothing. |
|
Hello! Sorry that I forgot to follow up on this. My first child was born about a week before I cranked out this PR so I have been a bit distracted lol. I don't even know where I found the time for the original submission lolololol |
3 participants
Hello! I've seen YouTube videos use this template as a starting point. When visiting the repo I was surprised that there weren't prominent instructions for people who just want to set up a project quickly and don't want to read the full README. So here's my attempt to add those instructions!