Skip to content

Commit 48a4b28

Browse files
committed
Merge pull request #150 from zafarella/patch-1
Shorter README.md
2 parents b5ac1ae + 04b6a71 commit 48a4b28

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ discussion on scoverage.
1212

1313
## How to use
1414

15-
Add the plugin to your build with the following in project/plugins.sbt:
15+
Add the plugin in project/plugins.sbt:
1616
```scala
1717
addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.3.3")
1818
```
1919

20-
Then run the your tests with coverage enabled by entering:
20+
Run the tests with enabled coverage:
2121
```
2222
$ sbt clean coverage test
2323
```
@@ -26,24 +26,23 @@ or if you have integration tests as well
2626
$ sbt clean coverage it:test
2727
```
2828

29-
You can also enable coverage directly in your build:
29+
To enable coverage directly in your build, use:
3030
```
3131
coverageEnabled := true
3232
```
3333

34-
After the tests have finished you should then run
35-
34+
To generate the coverage reports run
3635
```
3736
$ sbt coverageReport
3837
```
3938

40-
to generate the reports. You will find the coverage reports inside `target/scoverage-report`. There are HTML and XML reports. The XML is useful if you need to programatically use the results, or if you're writing a tool.
39+
Coverage reports will be in `target/scoverage-report`. There are HTML and XML reports. The XML is useful if you need to programatically use the results, or if you're writing a tool.
4140

4241
If you're running the coverage reports from within an sbt console session (as
4342
opposed to one command per sbt launch), then the `coverage` command is sticky. To
4443
turn it back off when you're done running reports, use the `coverageOff` command or reset `coverageEnabled` with `set coverageEnabled := false`.
4544

46-
If you want to see a project that is already setup to use scoverage in both sbt and maven, then clone [the scoverage samples project](https://github.com/scoverage/scoverage-samples).
45+
Sample project with scoverage in both sbt and maven - [the scoverage samples project](https://github.com/scoverage/scoverage-samples).
4746

4847
## Notes on upgrading to version 1.3.0
4948

@@ -86,11 +85,10 @@ Any code between two such comments will not be instrumented or included in the c
8685

8786
## Minimum coverage
8887

89-
You can use the following two keys to set the minimum coverage, and if you want to fail the build if the coverage is less than the minimum.
88+
Based on minimum coverage, you can fail the build with the following keys
9089

9190
```scala
9291
coverageMinimum := 80
93-
9492
coverageFailOnMinimum := true
9593
```
9694

0 commit comments

Comments
 (0)