Skip to content

Commit b9520ab

Browse files
committed
Fixed typos in README.md
1 parent 0e66ab4 commit b9520ab

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
# Android-Root-Coverage-Plugin
22
**A Gradle plugin for easy generation of combined code coverage reports for Android projects with multiple modules.**
3-
Android Projects that make use of the Gradle build system by default come with easy methods to generate code coverage reports. Unfortently by default code coverage is generated seperatly per module, this means each modules takes into account it's own sources and tests, which is in terms of domain seperation fine. Howerver it is very common to find multi-module Android project where only one module has instrumented tests, or full-fledged UI tests using Espresso. This plugin comes in handy for those projects. It generates code coverage reports using Jacoco taking into account all the modules and tests at once.
3+
Generating code coverage reports for Android Projects that make use of the Gradle build is quite easy. Unfortunately by default code coverage is generated separately per module, this means each modules takes into account it's own sources and tests, which is in terms of domain separation fine. However it is very common to find multi-module Android project where only one module has instrumented tests, or full-fledged UI tests using Espresso. This plugin comes in handy for those projects. It generates code coverage reports using Jacoco taking into account all the modules and tests at once.
44

55
- Supports both Android app and library modules (`com.android.application` & `com.android.library`).
66
- Supports different build variants per module within the same report.
77
- Supports custom filters.
88

9-
# Download
10-
The plugin is not yet available on Maven Central, so currently it is needed to add the following repository to your top-level gradle file:
9+
# Setup
10+
Apply the Android-Root-Coverage-Plugin plugin to your top-level (root project) gradle file following these 3 steps:
1111

12-
**Step 1:**
1312
```
1413
// Step 3: Apply the plugin to the top-level gradle file
1514
apply plugin: 'org.neotech.plugin.rootcoverage'
@@ -32,7 +31,7 @@ buildscript {
3231
# How to use
3332
Currently only modules with the plugin type `com.android.application` or `com.android.library` are taken into account when generating the root code coverage report, besides this any module that does not have `testCoverageEnabled true` for the default build variant (`debug`) will be skipped::
3433

35-
You can add a module by enableing `testCoverageEnabled`:
34+
You can add a module by enabling `testCoverageEnabled`:
3635
```
3736
android {
3837
buildTypes {
@@ -64,7 +63,7 @@ rootCoverage {
6463

6564

6665
# Development
67-
Want to contribute? Great! Currently this plugin is in need of extensive testing. Besides this there is also a small whish list:
66+
Want to contribute? Great! Currently this plugin is in need of extensive testing. Besides this there is also a small wish list:
6867

6968
- Support for Java modules
7069
- Make use of the JacocoMerge task? To merge the `exec` en `ec` files?

0 commit comments

Comments
 (0)