From 23e8a039ad5fcb10f45ea68ae982c6400cfd39d9 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Wed, 3 Jun 2015 16:27:39 -0700 Subject: [PATCH] README: bit of cleanup --- README.md | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index cac1e000..dc8798fe 100644 --- a/README.md +++ b/README.md @@ -110,14 +110,6 @@ 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 "real" 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 'time' segment By default the time is show in 'H:M:S' format. If you want to change it, @@ -126,6 +118,15 @@ just set another format in your `~/.zshrc`: # Reversed time format POWERLEVEL9K_TIME_FORMAT='%D{%S:%M:%H}' +#### Unit Test Ratios + +The `symfony2_tests` and `rspec_tests` segments both show a ratio of "real" +classes vs test classes in your source code. This is just a very simple ratio, +and does not show your code coverage or any sophisticated stats. All this does +is count your source files and test files, and calculate the ratio between them. +Just enough to give you a quick overview about the test situation of the project +you are dealing with. + #### The 'vcs' Segment By default, the `vcs` segment will provide quite a bit of information. If you @@ -184,20 +185,25 @@ Light'](https://github.com/altercation/solarized) users. Check it out: #### Further color customizations -For every segment you can specify foreground and background color by setting them in your `~/.zshrc`: +For each segment in your prompt, you can specify a foreground and background +color by setting them in your `~/.zshrc`. For example, to change the appearance +of the `time` segment, you would use: POWERLEVEL9K_TIME_FOREGROUND='red' POWERLEVEL9K_TIME_BACKGROUND='blue' -This will change the appearance of the `time` segment. Take the segment names from the Chapter `Segment Customization`. -Some of the Segments have special color variables, as they change the colors according some internal rules. These Segments are `vcs`, `rspec_stats`, `symfony2_tests`: +Use the segment names from the above section `Segment Customization`. Some of +the Segments have special color variables, as they change the colors according +to some internal rules. These Segments are `vcs`, `rspec_stats`, `symfony2_tests`: + # General VCS color segments: POWERLEVEL9K_VCS_FOREGROUND='blue' POWERLEVEL9K_VCS_DARK_FOREGROUND='black' POWERLEVEL9K_VCS_BACKGROUND='green' # If VCS changes are detected: POWERLEVEL9K_VCS_MODIFIED_FOREGROUND='red' POWERLEVEL9K_VCS_MODIFIED_BACKGROUND='cyan' + # rspec_stats for good test coverage POWERLEVEL9K_RSPEC_STATS_GOOD_FOREGROUND='blue' POWERLEVEL9K_RSPEC_STATS_GOOD_BACKGROUND='green' @@ -207,6 +213,7 @@ Some of the Segments have special color variables, as they change the colors acc # rspec_stats for poor test coverage POWERLEVEL9K_RSPEC_STATS_BAD_FOREGROUND='red' POWERLEVEL9K_RSPEC_STATS_BAD_BACKGROUND='white' + # symfony2_tests for good test coverage POWERLEVEL9K_SYMFONY2_TESTS_GOOD_FOREGROUND='blue' POWERLEVEL9K_SYMFONY2_TESTS_GOOD_BACKGROUND='green' @@ -217,11 +224,12 @@ Some of the Segments have special color variables, as they change the colors acc POWERLEVEL9K_SYMFONY2_TESTS_BAD_FOREGROUND='red' POWERLEVEL9K_SYMFONY2_TESTS_BAD_BACKGROUND='white' -You could also use a colorcode as value. Example: +You could also use a colorcode value. Example: POWERLEVEL9K_VCS_FOREGROUND='021' # Dark blue -For a full list of supported colors just type `spectrum_ls` in your terminal to see all possibilities. +For a full list of supported colors, run the `spectrum_ls` program in your +terminal. ### Troubleshooting