Onboarding: Add a quick-start guide or equivalent to README

Description

Provide a better onboarding experience by leveraging a getting started section in the readme along with an information popup.

Work

• add informational popup on first install of the extension / (on update as well?)
• add new section to the readme for quick-start with gifs around how to use the extension
• link this section in the “onboarding” popup message
• add new gif in readme for “basic” functionality (new colour blind friendly presentation)

Dev Triage

https://code.visualstudio.com/api/references/vscode-api#3120 https://code.visualstudio.com/api/references/extension-guidelines#notifications https://code.visualstudio.com/api/references/contribution-points#contributes.walkthroughs

---

Original Ticket

Describe the bug I went to the discussions / issues looking for documentation or other related issues. I was following the Python example in my own project, but couldn’t figure out how to actually display the coverage – until I eventually realized I needed to “activate” the extension by using some of these commands in the command palette:

Since the extension does not auto-activate when installed, it wasn’t clear to me if there was some additional configuration needed to get it going. Perhaps a simple Quick Start section in the README (or in the examples’ respective README files) to indicate this would be helpful, since it’s not immediately obvious what steps to take to actually display line coverage.

To Reproduce Steps to reproduce the behaviour:

1. Install the extension
2. Generate coverage file (in my case, cov.xml)

Expected behaviour Expect to see line coverage in tested file, but there will not be any without using one of the command palette commands.

[DannyDannyDanny]

Bump! I haven’t been able to get the plugin working. I’m sorely missing a getting started or troubleshooting section 🥇

[ryanluker]

@DanielTOsborne Thanks for the heads-up on Gradle being another option for the java folks (something that should be possible to add to the examples where we currently have a maven example).

@mattseddon Thanks for the heads up on the walkthroughs! Definitely look like something we should add.