diff --git a/README.md b/README.md index 130a974..8b94e2b 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,42 @@ [![Scribble](https://img.shields.io/badge/Docs-Scribble-blue.svg)](http://pkg-build.racket-lang.org/doc/cover/index.html) [![Stories in Ready](https://badge.waffle.io/florence/cover.png?label=ready&title=Ready)](https://waffle.io/florence/cover) -This library is an extensible code coverage tool for racket. +This library is an extensible code coverage tool for racket. It comes with the ability to generate +HTML reports, and has extensions to submit coverage reports to [Coveralls](https://coveralls.io/). +You can also create your own coverage formats. ## How to install Install via `raco pkg install cover`. To install for development, checkout the repository, `cd` into the new directory and run `raco pkg install`. -## How to use +## Basic Usage -To view the arguments for Cover run `raco cover -h`. +The basic usage of Cover will generate an HTML report. For example, checkout and install this +library and run `raco cover .` in that directory. Then open `coverage/index.html` in your favorite +web browser. You should see something like this: -Code coverage can be generated by specifying the `-f ` flag. +![Example](index_example.png) + +You can sort the entries by clicking on the header for any column. You can see a more detailed view +for any file by clicking on its name. For example, `private/format-utils.rkt` looks like: + +![Example2](page_example.png) + +You can view the arguments for Cover run `raco cover -h`. + +## Different Formats + +Code coverage can be generated in a different format by specifying the `-f ` flag. The only built in format is `html` simply generates html files for each source file containing -coverage information and highlighted source code. +coverage information and highlighted source code. This is the default. -For integration with coveralls see [cover-coveralls](https://github.com/rpless/cover-coveralls). +If you would like to use Cover with [Coveralls](https://coveralls.io/) see +[cover-coveralls](https://github.com/rpless/cover-coveralls). -For more detailed usage see [the full documentation](http://pkg-build.racket-lang.org/doc/cover/index.html). +You can also build a custom output format. For more detailed usage see +[the full documentation](http://pkg-build.racket-lang.org/doc/cover/index.html). ## Use with TravisCI diff --git a/cover/index_example.png b/cover/index_example.png new file mode 100644 index 0000000..8c4a5de Binary files /dev/null and b/cover/index_example.png differ diff --git a/cover/page_example.png b/cover/page_example.png new file mode 100644 index 0000000..b4af9f8 Binary files /dev/null and b/cover/page_example.png differ