summaryrefslogtreecommitdiff
path: root/plugins/git-prompt
diff options
context:
space:
mode:
authorDavid Chin <prehensilecode@users.noreply.github.com>2024-04-07 01:23:19 +0800
committerGitHub <noreply@github.com>2024-04-06 10:23:19 -0700
commitbf713e2c112ee1f0daf10deffa1215c982513f9b (patch)
tree7137a8a1c0e53eadaecbce18addbe0fa16f8038b /plugins/git-prompt
parentd893dd9b83d518f2b2bd4b9a5b6a92ca0e4e33e2 (diff)
downloadzsh-bf713e2c112ee1f0daf10deffa1215c982513f9b.tar.gz
zsh-bf713e2c112ee1f0daf10deffa1215c982513f9b.tar.bz2
zsh-bf713e2c112ee1f0daf10deffa1215c982513f9b.zip
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.
Diffstat (limited to 'plugins/git-prompt')
-rw-r--r--plugins/git-prompt/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/plugins/git-prompt/README.md b/plugins/git-prompt/README.md
index 05208d72f..8f42c6842 100644
--- a/plugins/git-prompt/README.md
+++ b/plugins/git-prompt/README.md
@@ -9,6 +9,10 @@ To use it, add `git-prompt` to the plugins array in your zshrc file:
plugins=(... git-prompt)
```
+You may also need to [customize your theme](https://github.com/ohmyzsh/ohmyzsh/issues/9395#issuecomment-1027130429)
+to change the way the prompt is built. See the
+[OMZ wiki on customizing themes](https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#overriding-and-adding-themes).
+
See the [original repository](https://github.com/olivierverdier/zsh-git-prompt).
## Requirements