mirror of
https://github.com/romkatv/powerlevel10k.git
synced 2024-11-25 13:30:07 +00:00
README: bit of cleanup
This commit is contained in:
parent
10c4bdaab2
commit
23e8a039ad
1 changed files with 21 additions and 13 deletions
34
README.md
34
README.md
|
@ -110,14 +110,6 @@ elements (it is by default), and define a `DEFAULT_USER` in your `~/.zshrc`:
|
||||||
|
|
||||||
export DEFAULT_USER=<your username>
|
export DEFAULT_USER=<your username>
|
||||||
|
|
||||||
#### 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
|
#### The 'time' segment
|
||||||
|
|
||||||
By default the time is show in 'H:M:S' format. If you want to change it,
|
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
|
# Reversed time format
|
||||||
POWERLEVEL9K_TIME_FORMAT='%D{%S:%M:%H}'
|
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
|
#### The 'vcs' Segment
|
||||||
|
|
||||||
By default, the `vcs` segment will provide quite a bit of information. If you
|
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
|
#### 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_FOREGROUND='red'
|
||||||
POWERLEVEL9K_TIME_BACKGROUND='blue'
|
POWERLEVEL9K_TIME_BACKGROUND='blue'
|
||||||
|
|
||||||
This will change the appearance of the `time` segment. Take the segment names from the Chapter `Segment Customization`.
|
Use the segment names from the above section `Segment Customization`. Some of
|
||||||
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`:
|
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_FOREGROUND='blue'
|
||||||
POWERLEVEL9K_VCS_DARK_FOREGROUND='black'
|
POWERLEVEL9K_VCS_DARK_FOREGROUND='black'
|
||||||
POWERLEVEL9K_VCS_BACKGROUND='green'
|
POWERLEVEL9K_VCS_BACKGROUND='green'
|
||||||
# If VCS changes are detected:
|
# If VCS changes are detected:
|
||||||
POWERLEVEL9K_VCS_MODIFIED_FOREGROUND='red'
|
POWERLEVEL9K_VCS_MODIFIED_FOREGROUND='red'
|
||||||
POWERLEVEL9K_VCS_MODIFIED_BACKGROUND='cyan'
|
POWERLEVEL9K_VCS_MODIFIED_BACKGROUND='cyan'
|
||||||
|
|
||||||
# rspec_stats for good test coverage
|
# rspec_stats for good test coverage
|
||||||
POWERLEVEL9K_RSPEC_STATS_GOOD_FOREGROUND='blue'
|
POWERLEVEL9K_RSPEC_STATS_GOOD_FOREGROUND='blue'
|
||||||
POWERLEVEL9K_RSPEC_STATS_GOOD_BACKGROUND='green'
|
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
|
# rspec_stats for poor test coverage
|
||||||
POWERLEVEL9K_RSPEC_STATS_BAD_FOREGROUND='red'
|
POWERLEVEL9K_RSPEC_STATS_BAD_FOREGROUND='red'
|
||||||
POWERLEVEL9K_RSPEC_STATS_BAD_BACKGROUND='white'
|
POWERLEVEL9K_RSPEC_STATS_BAD_BACKGROUND='white'
|
||||||
|
|
||||||
# symfony2_tests for good test coverage
|
# symfony2_tests for good test coverage
|
||||||
POWERLEVEL9K_SYMFONY2_TESTS_GOOD_FOREGROUND='blue'
|
POWERLEVEL9K_SYMFONY2_TESTS_GOOD_FOREGROUND='blue'
|
||||||
POWERLEVEL9K_SYMFONY2_TESTS_GOOD_BACKGROUND='green'
|
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_FOREGROUND='red'
|
||||||
POWERLEVEL9K_SYMFONY2_TESTS_BAD_BACKGROUND='white'
|
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
|
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
|
### Troubleshooting
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue