-
Notifications
You must be signed in to change notification settings - Fork 110
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a quickstart #93
base: main
Are you sure you want to change the base?
Add a quickstart #93
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, you could generate it using elf2uf2-rs and only have an RP2040 board and a usbcable :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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"
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!