Skip to content
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

Mention + document other runners #16

Closed
9names opened this issue Dec 11, 2021 · 6 comments · Fixed by #49
Closed

Mention + document other runners #16

9names opened this issue Dec 11, 2021 · 6 comments · Fixed by #49

Comments

@9names
Copy link
Member

9names commented Dec 11, 2021

Currently assume everyone wants probe-run.
Need to add how-to if for other runners to the docs, .cargo/config etc
elf2uf2 is added to the docs in #14

@jannic
Copy link
Member

jannic commented Mar 2, 2023

You added information about alternative runners to the README in #19. Does that fix this issue, or do you want to add more documentation?

@9names
Copy link
Member Author

9names commented Mar 2, 2023

My goal was to cover openocd/pyocd as well, but I quickly realised that it's too much to explain.
To be quite honest, I think we need to create an RP2040/W book and evict basically all docs from this repo. Maybe we can do that and deprecate this repo in favour of one without the fluff at the same time?

In the meantime: I fixed up a few more errors in the cargo-embed instructions + added probe-rs-cli run versions in #49, those are brief enough that I think we can afford to have them here for now.

@jannic
Copy link
Member

jannic commented Mar 2, 2023

To be quite honest, I think we need to create an RP2040/W book

There is still a lot of room for improvement, yes! But let's keep the existing documentation correct & up to date before we start a big new project.

Also, I prefer having basic documentation close to the code. It's perfectly fine to omit more complex details or alternative approaches, and refer to some central documentation instead, to avoid too much duplication. But the READMEs of individual crates should contain enough information to get started.

@jhodapp
Copy link

jhodapp commented Mar 2, 2023

My goal was to cover openocd/pyocd as well, but I quickly realised that it's too much to explain. To be quite honest, I think we need to create an RP2040/W book and evict basically all docs from this repo. Maybe we can do that and deprecate this repo in favour of one without the fluff at the same time?

If it's worth anything to these efforts, please feel free to take from the OpenOCD guide that I wrote here. I've tried keeping it relatively up to date but realize it may not be right now. So, feel free to take it or leave it.

@9names
Copy link
Member Author

9names commented Mar 15, 2023

@jhodapp Thanks for the offer! I might take you up on it.
I would want to strip it down to just the OpenOCD section and update it to use the CMSIS-DAP firmware and config to match how the official "Getting started guide" now does it
https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#page=62

Upstream OpenOCD releases now supports rp2040 over CMSIS-DAP, which should simplify the installation instructions even compared to the Pico guide.

@jhodapp
Copy link

jhodapp commented Mar 20, 2023

@9names thats great to know, I haven't tracked the latest here so I appreciate you letting me know upstream changed.

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 a pull request may close this issue.

3 participants