Adding a little documentation for the git themes

15 years ago · ff8e99beef
parent 85a4e30289
commit ff8e99beef
1 changed files with 6 additions and 1 deletions
--- a/git.zsh
+++ b/git.zsh
@ -1,4 +1,9 @@
-#
+# Varables for themeing the git info prompt:
+# ZSH_THEME_GIT_PROMPT_PREFIX - Prefix at the very beginning of the prompt, before the branch name
+# ZSH_THEME_GIT_PROMPT_SUFFIX - At the very end of the prompt
+# ZSH_THEME_GIT_PROMPT_DIRTY  - Text to display if the branch is dirty
+# ZSH_THEME_GIT_PROMPT_CLEAN  - Text to display if the branch is clean
+
 ZSH_THEME_GIT_PROMPT_PREFIX="git:("
 ZSH_THEME_GIT_PROMPT_SUFFIX=")"
 ZSH_THEME_GIT_PROMPT_DIRTY="*"