summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README2
-rw-r--r--index.txt38
2 files changed, 39 insertions, 1 deletions
diff --git a/README b/README
index 3fd45b9..9a937b5 100644
--- a/README
+++ b/README
@@ -8,7 +8,7 @@ INSTALL
Put following command in our profile in interactive section:
- . /etc/git-prompt.sh
+ . /path/to/git-prompt.sh
If there are no interactivity test in your profile, then above command should be:
diff --git a/index.txt b/index.txt
new file mode 100644
index 0000000..2a77e7a
--- /dev/null
+++ b/index.txt
@@ -0,0 +1,38 @@
+= GIT Prompt
+
+Get it from github: http://github.com/lvv/git-prompt/tree/master/git-prompt.sh[git-prompt.sh] +
+ git clone
+
+More info in http://github.com/lvv/git-prompt/tree/master/README[README]
+
+
+== Basic Usage
+
+image:screenshot-prompt-basic.png[basic usage]
+
+[red]*1* is `false(1)` exit code. Hosts are colored as configured in `git-prompt.sh` file.
+
+
+== GIT
+
+Branch and files are colored according to state. "M" stands for master.
+
+[cols="3,8",frame="topbot",options="header"]
+|================================================================
+| Color | Meaning
+| [green]#green# | Modified or new file. Modifications are in index but not in repo yet.
+| [red]#red# | Modified and tracked by repo, but modifications not added to index yet.
+| [lightblue]#light blue# | Untracked file.
+| [darkblue]#blue branch# | Clean
+| [red]#red# or [magenta]#magenta# branch | In middle of doing something or detached head.
+|================================================================
+
+image:screenshot-prompt-git.png[git module]
+
+== Subversion
+
+...
+
+== Labels
+
+...