From 8d52f7b1894ac00eb01b79129750d69a3d21b5dd Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Fri, 3 Apr 2015 16:41:08 +0200 Subject: [PATCH] Added Documentation. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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= +#### 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