summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael Allen <michael@michaelallen.io>2015-09-04 13:12:02 +0100
committerMichael Allen <michael@michaelallen.io>2015-09-04 13:12:02 +0100
commita6c7770c2456747d3f06102d0dad2cbbf0f81542 (patch)
treee984835fa47d660f4d3ca60a625394ba5d9ce6be /README.md
parent4487e954438f4fc216c301ad5fb9c1a1b5c690dd (diff)
downloadgit-sonar-a6c7770c2456747d3f06102d0dad2cbbf0f81542.tar.gz
git-sonar-a6c7770c2456747d3f06102d0dad2cbbf0f81542.zip
Adding new readme stuff to the table of contents
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8ca65f9..1538681 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,16 @@ last few years. Maybe it can help you too.
- [(Optional) Auto-fetch repos](#optional-auto-fetch-repos)
- [Support](#support)
- [Ensuring prompt execution](#ensuring-prompt-execution)
+ - [Configuring colours](#configuring-colours)
+ - [Exporting Environment Variables](#exporting-environment-variables)
+ - [Setting an RC file](#setting-an-rc-file)
+ - [Bash Colour Codes](#bash-colour-codes)
+ - [Zsh Colour Codes](#zsh-colour-codes)
+ - [Configuration values](#configuration-values)
+ - [Colouring the Branch part](#colouring-the-branch-part)
+ - [Colouring the local commits status](#colouring-the-local-commits-status)
+ - [Colouring the remote commits status](#colouring-the-remote-commits-status)
+ - [Colouring the file changes status](#colouring-the-file-changes-status)
- [License](#license)
## Installation
@@ -319,6 +329,8 @@ All these values should be set using a the correct colour code for your
terminal. You should also choose the colour code based on what shell you are
using. There is a way to support [colouring multiple shells using rc files](#setting-an-rc-file).
+##### Colouring the Branch part
+
**GIT_RADAR_COLOR_BRANCH='[colour code]'**
```
git:(my-branch)
@@ -330,6 +342,8 @@ It is unset by
`GIT_RADAR_COLOR_BRANCH_RESET` which you can set if you want a different
background colour to return to.
+##### Colouring the local commits status
+
**GIT_RADAR_COLOR_LOCAL_AHEAD='[colour code]'**
```
git:(my-branch 1↑)
@@ -362,6 +376,8 @@ The colour to use for the arrow that indicates how many commits your branch has
It is unset by `GIT_RADAR_COLOR_LOCAL_RESET` which you can set if you want
a different background colour to return to.
+##### Colouring the remote commits status
+
**GIT_RADAR_COLOR_REMOTE_AHEAD='[colour code]'**
```
git:(m ← 1 my-branch)
@@ -405,6 +421,8 @@ tracking an upstream branch.
It is unset by `GIT_RADAR_COLOR_REMOTE_RESET` which you can set if you want
a different background colour to return to.
+##### Colouring the file changes status
+
**GIT_RADAR_COLOR_CHANGES_STAGED='[colour code]'**
```
git:(my-branch) 1M