Improve Readme for published

probe-rs / vscode

VSCode debug extension for probe-rs. It uses the MS DAP protocol to communicate directly with the probe (via probe-rs), and supports basic command line debugging in addition to VSCode UI.

https://probe.rs/

Other

65 stars 6 forks source link

Improve Readme for published #47

Closed Tiwalun closed 1 year ago

Tiwalun commented 1 year ago

Great to see the extensions in the marketplace!

It seems that it now includes the README.md from this repo as the description for the extension. The readme has a lot of content specific to the development of the extension itself, which seems a bit out of place.

I don't know how the packaging works, but it would be nice to have more user focused review in the market place, and a developer focused in the repo.

noppej commented 1 year ago

I think that can be done ... I would probably take this approach:

marketplace README: just a teaser / brief showcase.
GitHub README: same, plus info for contributors
probe.rs: full docs.

Comments?

Yatekii commented 1 year ago

Sounds like a good plan to follow :)