From 43a0d72df3af12a2686440f6f9fc512d85c46c03 Mon Sep 17 00:00:00 2001 From: Martin Gondermann Date: Sat, 4 Oct 2014 22:00:13 +0200 Subject: [PATCH] Updated README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 756186c0..2fe64fed 100644 --- a/README.md +++ b/README.md @@ -103,11 +103,34 @@ git clone https://github.com/magicmonty/bash-git-prompt.git .bash-git-prompt # GIT_PROMPT_END=... # uncomment for custom prompt end sequence # as last entry source the gitprompt script + # GIT_PROMPT_THEME=Custom # use custom .git-prompt-colors.sh + # GIT_PROMPT_THEME=Solarized # use theme optimized for solarized color scheme source ~/.bash-git-prompt/gitprompt.sh ``` - `cd` to a git repository and test it! +#### Themes + +The most settings are now stored in theme files. To select a theme, set the variable `GIT_PROMPT_THEME` to the name +of the theme located in `/themes` without the extension `.bgptheme` like this: + +```sh +GIT_PROMPT_THEME=Solarized +``` + +If you set `GIT_PROMPT_THEME` to `Custom`, then the `.git-prompt-colors.sh` in the home directory will be used. +This file can now be generated with the command `git_prompt_make_custom_theme []`. If the name of +the base theme is ommitted or the theme file is not found, then the Default theme is used. If you have already a custom +`.git-prompt-colors.sh` in your home directory, a error message will be shown. + +You can display a list of available themes with `git_prompt_list_themes` (the current theme is highlighted) + +**If you omit the `GIT_PROMPT_THEME` variable, the Default theme is used or, if you have a custom `.git-prompt-colors.sh` +in your home directory, then the Custom theme is used.** + +#### Further customizations + - You can define `GIT_PROMPT_START` and `GIT_PROMPT_END` to tweak your prompt. - The default colors are defined within `prompt-colors.sh`, which is sourced by