summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDominik Ritter <dritter03@googlemail.com>2015-04-03 17:41:08 +0300
committerDominik Ritter <dritter03@googlemail.com>2015-04-03 17:41:08 +0300
commit8d52f7b1894ac00eb01b79129750d69a3d21b5dd (patch)
tree5f094b9494423b8826546206d9036c08f33571a1 /README.md
parentb1d6d3e67d6f6c936c1150ab5f438813bed0a23a (diff)
Added Documentation.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0dd20689..e03cd98b 100644
--- a/README.md
+++ b/README.md
@@ -109,6 +109,14 @@ elements (it is by default), and define a `DEFAULT_USER` in your `~/.zshrc`:
export DEFAULT_USER=<your username>
+#### Test ratio
+
+The `symfony2_tests` and `rspec_tests` segments show both a ratio of code classes
+vs test classes. This is just a very simple ratio, and does not show your code
+coverage or any sophisticated stats. All this does is just to count your files
+and test files and calculate the ratio between them. Not more, but is may give
+a quick overview about the test situation of the project you are dealing with.
+
#### The VCS Information Segment
By default, the `vcs` segment will provide quite a bit of information. If you