From e7735e6162c801f1f3092ec2ca883ea8d213e49c Mon Sep 17 00:00:00 2001 From: Martin Gondermann Date: Fri, 18 Apr 2014 21:09:32 +0200 Subject: [PATCH] updated README --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 32e3035..0fd4680 100644 --- a/README.md +++ b/README.md @@ -49,34 +49,40 @@ The symbols are as follows: ## Install -1. Clone this repository to your homedir +- Clone this repository to your homedir e.g. ``git clone https://github.com/magicmonty/bash-git-prompt.git .bash-git-prompt`` -2. Source the file ``gitprompt.sh`` from your ``~/.bashrc`` config file: - ```bash +- Source the file ``gitprompt.sh`` from your ``~/.bashrc`` config file: + +```sh # some other config in .bashrc # gitprompt configuration + + # Set config variables first + GIT_PROMPT_ONLY_IN_REPO=1 + + # as last entry source the gitprompt script source .bash-git-prompt/gitprompt.sh - ``` -3. Go in a git repository and test it! +``` + +- Go in a git repository and test it! ## Configuration -1. The default colors and some variables for tweaking the prompt are defined +- The default colors and some variables for tweaking the prompt are defined within ``gitprompt.sh``, but may be overridden by copying ``git-prompt-colors.sh`` to your home directory at ``~/.git-prompt-colors.sh``. This file may also be found in the same directory as ``gitprompt.sh``, but without the leading ``.``. -2. You can use ``GIT_PROMPT_START_USER``, ``GIT_PROMPT_START_ROOT``, ``GIT_PROMPT_END_USER`` and ``GIT_PROMPT_END_ROOT`` in your ``.git-prompt-colors.sh`` to tweak your prompt. You can also override the start and end of the prompt by setting ``GIT_PROMPT_START`` and ``GIT_PROMPT_END`` before you source the ``gitprompt.sh`` +- You can use ``GIT_PROMPT_START_USER``, ``GIT_PROMPT_START_ROOT``, ``GIT_PROMPT_END_USER`` and ``GIT_PROMPT_END_ROOT`` in your ``.git-prompt-colors.sh`` to tweak your prompt. You can also override the start and end of the prompt by setting ``GIT_PROMPT_START`` and ``GIT_PROMPT_END`` before you source the ``gitprompt.sh`` -3. The current git repo information is obtained by the script `gitstatus.sh` or +- The current git repo information is obtained by the script `gitstatus.sh` or `gitstatus.py`. Both scripts do the same thing, but the bash script is a tad more quick, and is used by default. If you prefer the python script (possibly because you have enhanced it), simply delete or change the name of ``gitstatus.sh``. -4. You can define ``prompt_callback`` function to tweak your prompt dynamically. - +- You can define ``prompt_callback`` function to tweak your prompt dynamically. ```sh function prompt_callback { if [ `jobs | wc -l` -ne 0 ]; then @@ -85,7 +91,9 @@ function prompt_callback { } ``` -5. You can get help on the git prompt with the function ``git_prompt_help``. +- If you want to show the git prompt only, if you are in a git repository you can set ``GIT_PROMPT_ONLY_IN_REPO=1`` before sourcing the gitprompt script + +- You can get help on the git prompt with the function ``git_prompt_help``. Examples are available with ``git_prompt_examples``. **Enjoy!**