summaryrefslogtreecommitdiff
path: root/plugins/git-prompt/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/git-prompt/README.md')
-rw-r--r--plugins/git-prompt/README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/plugins/git-prompt/README.md b/plugins/git-prompt/README.md
index c6610fa94..83d365c84 100644
--- a/plugins/git-prompt/README.md
+++ b/plugins/git-prompt/README.md
@@ -11,7 +11,8 @@ plugins=(... git-prompt)
See the [original repository](https://github.com/olivierverdier/zsh-git-prompt).
-## Prerequisites
+## Requirements
+
This plugin uses `python`, so your host needs to have it installed
## Examples
@@ -30,7 +31,7 @@ The prompt may look like the following:
By default, the general appearance of the prompt is:
-```
+```text
(<branch><branch tracking>|<local status>)
```
@@ -58,9 +59,8 @@ The symbols are as follows:
## Customisation
- Set the variable `ZSH_THEME_GIT_PROMPT_CACHE` to any value in order to enable caching.
-- You may also change a number of variables (whose name start with `ZSH_THEME_GIT_PROMPT_`)
+- You may also change a number of variables (whose name start with `ZSH_THEME_GIT_PROMPT_`)
to change the appearance of the prompt. Take a look at the bottom of the [plugin file](git-prompt.plugin.zsh)`
to see what variables are available.
-
**Enjoy!**