diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 33 |
1 files changed, 24 insertions, 9 deletions
@@ -37,6 +37,8 @@ Installation ### On Debian/Ubuntu +On a recent enough Debian (at least Stretch with backports enabled) or Ubuntu (at least 18.10) there is an official package available. + ```txt apt install powerline-gitstatus ``` @@ -104,10 +106,12 @@ Do this by passing `false` to the `use_dash_c` argument, for example in `.config Optionally, a tag description for the current branch may be displayed using the `show_tag` option. Valid values for this argument are: + * `last` : shows the most recent tag * `annotated` : shows the most recent annotated tag * `contains` : shows the closest tag that comes after the current commit * `exact` : shows a tag only if it matches the current commit + You can enable this by passing one of these to the `show_tag` argument, for example in `.config/powerline/themes/shell/__main__.json`: ```json @@ -123,7 +127,7 @@ Note: before v1.3.0, the behavior when the value is `True` was `last`. As of v1. Optionally the format in which Gitstatus shows information can be customized. This allows to use a different symbol or remove a fragment if desired. You can -customize string formats for _tag_, _behind_, _ahead_, _staged_, _unmerged_, +customize string formats for _branch_, _tag_, _behind_, _ahead_, _staged_, _unmerged_, _changed_, _untracked_ and _stash_ fragments with the following arguments in a theme configuration file, for example `.config/powerline/themes/shell/__main__.json`: @@ -131,14 +135,15 @@ theme configuration file, for example `.config/powerline/themes/shell/__main__.j "gitstatus": { "args": { "formats": { - "tag": " {}", - "behind": " {}", - "ahead": " {}", - "staged": " {}", - "unmerged": " {}", - "changed": " {}", - "untracked": " {}", - "stashed": " {}" + "branch": "\ue0a0 {}", + "tag": " ★ {}", + "behind": " ↓ {}", + "ahead": " ↑ {}", + "staged": " ● {}", + "unmerged": " ✖ {}", + "changed": " ✚ {}", + "untracked": " … {}", + "stashed": " ⚑ {}" } } } @@ -155,6 +160,16 @@ place of the branch name. This can be replaced with a description of the closest } } ``` + +By default, if your local branch has untracked files but no other changes, the branch status will be highlighted as dirty in the segment. You can disable this behavior by setting the `untracked_not_dirty` argument to `true`, for example in `.config/powerline/themes/shell/__main__.json`: + +```json +"gitstatus": { + "args": { + "untracked_not_dirty": true + } +} +``` License ------- |