README files for GitHub and extension marketplace

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

66 stars 6 forks source link

README files for GitHub and extension marketplace #52

Closed noppej closed 1 year ago

noppej commented 1 year ago

It turns out that the VS Extension Marketplace does not honour the "readme" setting in package.json.

This PR moves the README as follows:

.github/README.md : Developer focussed, and the landing page for GitHub (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)
README.md: User focussed, and the landing page for the VS Extension Marketplace.