Skip to content

Fixed headers in Readme.md #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
#SharpCover
# SharpCover
[![Build Status](https://travis-ci.org/gaillard/SharpCover.png)](https://travis-ci.org/gaillard/SharpCover)

C# code coverage tool with Linux ([Mono](https://github.com/mono/mono)) and Windows ([.NET 4.0](http://www.microsoft.com/en-us/download/details.aspx?id=17851)) support.

##Features
## Features

* [CIL](http://www.ecma-international.org/publications/standards/Ecma-335.htm) instruction coverage
* Namespace, class, method, line and instruction inclusions/exclusions
* Inclusions/Exclusions specifications are outside of code.
* Cross platform Linux/Windows by way of [Cecil](http://www.mono-project.com/Cecil)
* Easy integration into builds (target user program is invoked seperately)

##Usage
## Usage

* After [building](#tool-build) run `SharpCover.exe instrument json` where `json` is a string or file with contents that reflects the following format, most options
are optional:
Expand Down Expand Up @@ -41,7 +41,7 @@ The exit code will be zero on instrument success.
The results will be in `coverageResults.txt`, with missed instructions prefixed with `MISS !`.
The exit code will be zero for success, and total coverage percentage is printed.

###Notes
### Notes
Full `method` names for `methodBodyExcludes` can be found in the output, as well as offsets.

The `methodBodyExcludes` by `lines` are line content matches ignoring leading/trailing whitespace.
Expand All @@ -52,19 +52,19 @@ Remember to rebuild your assemblies before you instrument again !

It is highly recommended to use the includes/excludes to achieve a zero exit from `check`, otherwise you are cheating yourself !

##Tool Build
## Tool Build

Make sure you are in the repository root.

###Linux
### Linux

Make sure [Mono](https://github.com/mono/mono) which comes with [xbuild](http://www.mono-project.com/Microsoft.Build) is installed.

```bash
xbuild Gaillard.SharpCover/Program.csproj
```

###Windows
### Windows

Make sure [.NET SDK](http://www.microsoft.com/en-us/download/details.aspx?id=8279) which comes with [MSBuild](http://msdn.microsoft.com/en-us/library/dd393574.aspx) is installed.

Expand All @@ -74,7 +74,7 @@ C:\Windows\Microsoft.NET\Framework64\v4.0.30319\MSBuild.exe Gaillard.SharpCover\

Navigate to the `Gaillard.SharpCover/bin/Debug` directory where the `SharpCover.exe` executable can be used.

##Contact
## Contact

Developers may be contacted at:

Expand All @@ -83,12 +83,12 @@ Developers may be contacted at:

Questions / Feedback / Feature requests are welcome !!

##Project Build
## Project Build

Make sure you are in the repository root.
Make sure [nunit-console](http://www.nunit.org/index.php?p=nunit-console&r=2.2.10) is installed.

###Linux
### Linux

Make sure [Mono](https://github.com/mono/mono) which comes with [xbuild](http://www.mono-project.com/Microsoft.Build) is installed.

Expand All @@ -97,19 +97,19 @@ Make sure [Mono](https://github.com/mono/mono) which comes with [xbuild](http://
sh build.sh
```

###Windows
### Windows

Make sure [.NET SDK](http://www.microsoft.com/en-us/download/details.aspx?id=8279) which comes with [MSBuild](http://msdn.microsoft.com/en-us/library/dd393574.aspx) is installed.

```dos
build.bat
```

#####Notes
##### Notes

Some paths might need changing depending on your environment.

##Enhancements
## Enhancements

A standard output format that can be used with available visualizers would be very useful.

Expand Down