Skip to content

Commit

Permalink
Cleanup readme
Browse files Browse the repository at this point in the history
ryanluker authored Jan 9, 2023
1 parent 1b7414f commit 37e0b94
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# coverage-gutters
[![Version](https://vsmarketplacebadge.apphb.com/version/ryanluker.vscode-coverage-gutters.svg)](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters)
[![Installs](https://vsmarketplacebadge.apphb.com/installs/ryanluker.vscode-coverage-gutters.svg)](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters)
[![Ratings](https://vsmarketplacebadge.apphb.com/rating/ryanluker.vscode-coverage-gutters.svg)](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters)
[![Sponsor](https://img.shields.io/github/sponsors/ryanluker)](https://github.com/sponsors/ryanluker)
Display test coverage generated by lcov or xml in your editor.

## Call for Maintainers
Looking for helpful people to assist with bugs, new features or performance improvements. The project has a full suite of tests and code linting, making it very new contributor friendly. Take a look at some of the open github issues and see if any catch your eye!
Looking for helpful people to assist with bugs, new features or performance improvements.
The project has a full suite of tests and code linting, making it very new contributor friendly.
Take a look at some of the open github issues and see if any catch your eye!
https://github.com/ryanluker/vscode-coverage-gutters/issues

## Features
![Coverage Gutters features watch](promo_images/coverage-gutters-features-1.gif)

- Supports any language as long as you can generate an lcov style coverage file
- Supports any language as long as you can generate a lcov style coverage file
- Extensive logging and insight into operations via the output logs
- Multi coverage file support for both xml and lcov
- Coverage caching layer makes for speedy rendering even in large files
@@ -23,7 +22,7 @@ https://github.com/ryanluker/vscode-coverage-gutters/issues

## Common Commands
**Watch** (activated via command palette or shortcut icon on the status bar):
Activating watch allows the extension to keep track of coverage changes and update it's cache. It also will automatically apply coverage to a file if some exists.
Activating watch allows the extension to keep track of coverage changes and update its cache. It also will automatically apply coverage to a file if some exists.

**Display** (activated via command palette or shortcut key):
Displays coverage for the current activated file only, does not update if the coverage files change.
@@ -43,7 +42,7 @@ See [examples directory](example) on how to setup a project.
- [DotNet](example/dotnet)

## Tips and Tricks
**Using Breakpoints**: Currently to both use the extension and code debugging breakpoints you need to disable the gutter coverage and enable the line coverage via the settings ( `coverage-gutters.showGutterCoverage` and `coverage-gutters.showLineCoverage` respectively).
**Using Breakpoints**: Currently to both use the extension and code debugging breakpoints, you need to disable the gutter coverage and enable the line coverage via the settings ( `coverage-gutters.showGutterCoverage` and `coverage-gutters.showLineCoverage` respectively).

## Requirements
- vscode 1.27.0 and up
@@ -64,6 +63,11 @@ See extension setting options in IDE.
## Contribution Guidelines
### [Guidelines](/CONTRIBUTING.md)

## About Me
If you are interested in what else I work on, checkout my website or github profile!
https://luker.dev
https://github.com/ryanluker

-----------------------------------------------------------------------------------------------------------

<div>Icon made by <a href="http://www.flaticon.com/authors/dave-gandy" title="Dave Gandy">Dave Gandy</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></div>

0 comments on commit 37e0b94

Please sign in to comment.