David Chin <prehensilecode@users.noreply.github.com>
Committer
GitHub <noreply@github.com>
Date
Message
Update README for git-prompt to clarify how to use (#10922)
* Add note about need to customise theme.
It may not be obvious that the theme needs to be customised. See: https://github.com/ohmyzsh/ohmyzsh/issues/9395
* Clarify type of theme customisation needed.
Diff
1diff --git a/plugins/git-prompt/README.md b/plugins/git-prompt/README.md
2index 05208d72f81aba12941e3e0b83601fa7a68d9c5e..8f42c6842731d7cc9ea7f99c39dc9e355ec77ae9 100644
3--- a/plugins/git-prompt/README.md
4+++ b/plugins/git-prompt/README.md
5@@ -9,6 +9,10 @@ To use it, add `git-prompt` to the plugins array in your zshrc file:
6 plugins=(... git-prompt)
7 ```
8 9+You may also need to [customize your theme](https://github.com/ohmyzsh/ohmyzsh/issues/9395#issuecomment-1027130429)
10+to change the way the prompt is built. See the
11+[OMZ wiki on customizing themes](https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#overriding-and-adding-themes).
12+
13 See the [original repository](https://github.com/olivierverdier/zsh-git-prompt).
1415 ## Requirements