My version with timeout, ahead/behind/staged/untracked markers and counts, and zsh support

README.md

@@ -1,11 +1,11 @@
-# Git Aware Prompt
+# Git Aware Prompt (joeytwiddle's fork)
 
 Working with Git and its great branching/merging features is
 amazing. Constantly switching branches can be confusing though as you have to
 run `git status` to see which branch you're currently on.
 
 The solution to this is to have your terminal prompt display the current
-branch. There's a [number][1] [of][2] [articles][3] [available][4] online
+branch. There are a [number][1] [of][2] [articles][3] [available][4] online
 about how to achieve this. This project is an attempt to make an easy to
 install/configure solution.
 
@@ -21,7 +21,67 @@ If you `cd` to a Git working directory, you will see the current Git branch
 name displayed in your terminal prompt. When you're not in a Git working
 directory, your prompt works like normal.
 
-![Git Branch in Prompt](https://raw.github.com/jimeh/git-aware-prompt/master/preview.png)
+.
+
+**This fork by joeytwiddle also:**
+- shows you how far your local branch is **ahead** or **behind** the repository's branch
+- shows how many files are **staged**
+- indicates when you have an un-popped **stash** (when the top stash entry was made on the current commit or the current branch)
+- displays when you are on a **detached** commit, or paused during a merge, rebase or cherry-pick
+- adds a **timeout** for slower machines so that you will get your prompt quickly, even if `git status` is taking too long to retrieve the dirty and staged stats. (Tested in bash and zsh.)
+
+.
+
+If you *only* want the ahead/behind marks (no timeout and no staged stats), you may prefer the branch [ahead_behind](https://github.com/joeytwiddle/git-aware-prompt/tree/ahead_behind) or if you are curious about the code, see [ahead_behind_simple](https://github.com/joeytwiddle/git-aware-prompt/tree/ahead_behind_simple) ([compare](https://github.com/joeytwiddle/git-aware-prompt/compare/jimeh:518685d5d42ab9f298207dd66bbc213775c5cbee...ahead_behind_simple?expand=1)).
+
+The initial implementation of the timeout feature is on [this commit](https://github.com/joeytwiddle/git-aware-prompt/commit/29a89c1e6890689c819303ad33ef70ae4233589c).
+
+![Git Branch in Prompt](https://github.com/joeytwiddle/git-aware-prompt/raw/master/preview.png)
+
+> `≡` is a reminder that I have something on the stash.
+>
+> `<3` indicates that the local branch is 3 commits behind the upstream (remote) branch, and could/should be pulled.
+>
+> `?1` indicates that there is 1 untracked file in the tree.
+>
+> `+1` indicates that one file is staged for comitting.
+>
+> `>1` indicates that the local branch has 1 commit which has not yet been pushed to the upstream.
+>
+> `*1` indicates that the branch is dirty, with 1 file modified but not committed.
+>
+> `#` would indicate that `git status` has taken too long, so the markers are not shown.
+>
+>  In that situation, `git status` will continue running in the background, so after a few moments, hitting `<Enter>` again should give you an up-to-date summary.
+
+We also have some indicators for the current branch:
+
+> `[branch_name]` means you are on a branch with an upstream
+>
+> `(branch_name)` means you are on a branch without an upstream
+>
+> `{branch_name\mode}` means you are in the middle of a merge, rebase, cherry-pick, revert or bisect
+>
+> `<commit_id>` means you are detached on the given commit, tag, or remote branch
+
+The symbols (or "markers") can be changed by editing the `prompt.sh` file directly (and reloading it of course).  The numbers or the markers can be omitted by removing the `_count` or `_mark` variables from the `PS1` prompt below.
+
+
+## See Also
+
+- The [original git-aware-prompt](https://github.com/jimeh/git-aware-prompt) by jimeh, from which this version is forked
+
+- The [prompt now distributed with git](https://github.com/git/git/blob/master/contrib/completion/git-prompt.sh) offers a `GIT_PS1_SHOWUPSTREAM` option.
+
+- Zsh now ships with [vcs_info](https://git-scm.com/book/tr/v2/Appendix-A%3A-Git-in-Other-Environments-Git-in-Zsh) which works for a variety of version control systems.  (Unfortunately the docs for this are a big gnarly.)
+
+- [Oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) has its own [git-prompt](https://github.com/robbyrussell/oh-my-zsh/blob/master/plugins/gitfast/git-prompt.sh).  (It has 500 lines compared to our 200.)
+
+- Inspiration for this fork came from [git-branch-status](https://gist.github.com/jehiah/1288596) by jehiah (a command, not a prompt)
+
+- [pure](https://github.com/sindresorhus/pure) prompt by sindresorhus includes good git support (for zsh only)
+
+- [liquidprompt](https://github.com/nojhan/liquidprompt) includes some git support (for bash and zsh)
 
 
 ## Installation
@@ -31,14 +91,13 @@ Clone the project to a `.bash` folder in your home directory:
 ```bash
 mkdir ~/.bash
 cd ~/.bash
-git clone git://github.com/jimeh/git-aware-prompt.git
+git clone git://github.com/joeytwiddle/git-aware-prompt.git
 ```
 
 Edit your `~/.bash_profile` or `~/.profile` or `~/.bashrc` (for Ubuntu) and add the following to the top:
 
 ```bash
-export GITAWAREPROMPT=~/.bash/git-aware-prompt
-source "${GITAWAREPROMPT}/main.sh"
+source "~/.bash/git-aware-prompt/main.sh"
 ```
 
 
@@ -65,14 +124,14 @@ end of the same file you pasted the installation code into earlier.
 #### Mac OS X
 
 ```bash
-export PS1="\u@\h \W \[$txtcyn\]\$git_branch\[$txtred\]\$git_dirty\[$txtrst\]\$ "
+export PS1="\u@\h \W\[$txtcyn\]\$git_branch\[$bldgrn\]\$git_ahead_mark\$git_ahead_count\[$txtrst\]\[$bldred\]\$git_behind_mark\$git_behind_count\[$txtrst\]\[$bldylw\]\$git_stash_mark\[$txtrst\]\[$txtylw\]\$git_dirty\$git_dirty_count\[$txtrst\]\[$txtcyn\]\$git_staged_mark\$git_staged_count\[$txtrst\]\[$txtblu\]\$git_unknown_mark\$git_unknown_count\[$txtrst\]\$ "
 ```
 
 Optionally, if you want a nice pretty prompt when using `sudo -s`, also add
 this line:
 
 ```bash
-export SUDO_PS1="\[$bakred\]\u@\h\[$txtrst\] \w\$ "
+export SUDO_PS1="\[$bakred\]\u@\h\[$txtrst\]\w\$ "
 ```
 
 
@@ -81,13 +140,20 @@ export SUDO_PS1="\[$bakred\]\u@\h\[$txtrst\] \w\$ "
 Standard:
 
 ```bash
-export PS1="\${debian_chroot:+(\$debian_chroot)}\u@\h:\w \[$txtcyn\]\$git_branch\[$txtred\]\$git_dirty\[$txtrst\]\$ "
+export PS1="\${debian_chroot:+(\$debian_chroot)}\u@\h:\w\[$txtcyn\]\$git_branch\[$bldgrn\]\$git_ahead_mark\$git_ahead_count\[$txtrst\]\[$bldred\]\$git_behind_mark\$git_behind_count\[$txtrst\]\[$bldyellow\]\$git_stash_mark\[$txtrst\]\[$txtylw\]\$git_dirty\$git_dirty_count\[$txtrst\]\[$txtcyn\]\$git_staged_mark\$git_staged_count\[$txtrst\]\[$txtblu\]\$git_unknown_mark\$git_unknown_count\[$txtrst\]\$ "
 ```
 
 Colorized:
 
 ```bash
-export PS1="\${debian_chroot:+(\$debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\] \[$txtcyn\]\$git_branch\[$txtred\]\$git_dirty\[$txtrst\]\$ "
+export PS1="\${debian_chroot:+(\$debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\[$txtcyn\]\$git_branch\[$bldgrn\]\$git_ahead_mark\$git_ahead_count\[$txtrst\]\[$bldred\]\$git_behind_mark\$git_behind_count\[$txtrst\]\[$bldyellow\]\$git_stash_mark\[$txtrst\]\[$txtylw\]\$git_dirty\$git_dirty_count\[$txtrst\]\[$txtcyn\]\$git_staged_mark\$git_staged_count\[$txtrst\]\[$txtblu\]\$git_unknown_mark\$git_unknown_count\[$txtrst\]\$ "
+```
+
+
+#### ZSH
+
+```zsh
+export PROMPT='%n@%m:%~%{$bldpur%}$git_branch%{$bldgrn%}$git_ahead_mark$git_ahead_count%{$bldred%}$git_behind_mark$git_behind_count%{$bldylw%}$git_stash_mark%{$txtrst$txtylw%}$git_dirty$git_dirty_count%{$txtcyn%}$git_staged_mark$git_staged_count%{$txtblu%}$git_unknown_mark$git_unknown_count%{$txtrst%}$ '
 ```
 
 

main.sh

@@ -1,2 +1,2 @@
-source "${GITAWAREPROMPT}/colors.sh"
-source "${GITAWAREPROMPT}/prompt.sh"
+source "$(dirname $0)/colors.sh"
+source "$(dirname $0)/prompt.sh"