Skip to content

Commit 5521a13

Browse files
committed
Update README
1 parent 429de71 commit 5521a13

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,34 @@ Painless code coverage reporting for Objective-C projects. Most of the heavy l
44
## Installation
55

66
$ gem install alcove
7-
8-
If you don't have it already, you'll also need to install lcov.
97

10-
*Homebrew*
8+
You'll also need to install lcov.
9+
10+
With *Homebrew*:
1111

1212
$ brew install lcov
1313

14-
*MacPorts*
14+
Or with *MacPorts*:
1515

1616
$ sudo port install lcov
1717

1818
## Xcode Project Configuration
19-
If you haven't already, open your project in Xcode and update your non-test targets to Generate Test Coverage Files and Instrument Program Flow (*for Debug configuration only*).
19+
Open your project in Xcode and update your non-test targets to Generate Test Coverage Files and Instrument Program Flow (*for Debug configuration only*).
2020
![Xcode](http://i.imgur.com/xdcg4er.png?1)
2121

2222
## Generating Reports
2323
Now that you have the prerequisites out of the way, you can generate a report. Make sure you've recently executed your tests, then:
2424

2525
alcove --product-name <your-product-name>
2626

27-
Be sure to check out the --help for additional options for fine-tuning your report.
28-
2927
## Options
3028

3129
### --output-directory
3230
Specify this option to change the output directory for the report. Any intermediate paths will be created.
3331

32+
### --percent-file
33+
Generates a plaintext file `alcove-percent.txt` in the output directory, containing only the line coverage percentage.
34+
3435
### --product-name
3536
The product name specified in your Xcode project.
3637

@@ -40,5 +41,8 @@ A list of filters to use when gathering files for the report. Use this if you w
4041
### --search-directory
4142
Use this option to specify the directory to be searched for your product. Alcove plays nicely with the the structure on your development machine, as well as on an Xcode Server, but if you have some funky output directory for your build, you can specify its parent here.
4243

43-
## Attribution
44-
Shoutout to [@NateBank](https://github.com/NateBank) for the [name suggestion](https://www.youtube.com/watch?v=j1Q-a5zCmhc).
44+
## Troubleshooting
45+
If something doesn't seem quite right, try cleaning the build folder and then run the tests again. Make sure you can generate a report for the [demo project](https://github.com/ioveracker/AlcoveDemo), too.
46+
47+
## Thanks
48+
Shoutout to [@NateBank](https://github.com/NateBank) for the [name suggestion](https://www.youtube.com/watch?v=j1Q-a5zCmhc) and inspiration.

0 commit comments

Comments
 (0)