Skip to content

Commit 1472a46

Browse files
committed
Add prettier screenshot
1 parent 7bbb549 commit 1472a46

File tree

2 files changed

+21
-19
lines changed

2 files changed

+21
-19
lines changed

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,33 @@ If you *only* want the ahead/behind marks (no timeout and no staged stats), you
3232

3333
The initial implementation of the timeout feature is on [this commit](https://github.com/joeytwiddle/git-aware-prompt/commit/29a89c1e6890689c819303ad33ef70ae4233589c).
3434

35-
![Git Branch in Prompt](https://raw.github.com/joeytwiddle/git-aware-prompt/master/preview.png)
36-
37-
> `<3` indicates that the local branch is 3 commits behind the upstream/remote branch, and could be updated.
38-
39-
> `*2` indicates that the branch is now dirty, with 2 files modified but not committed.
40-
41-
> `>1` indicates that the local branch has 1 commit which has not yet been pushed.
42-
43-
> `+1` would indicate that you have staged 1 file before comitting, but that is not shown above.
44-
45-
> `?4` would indicate that there are 4 untracked files in the tree, also not shown.
46-
47-
> `#` indicates that `git status` was taking too long, so dirty `*` staged `+` and untracked `?` markers will not be shown this time. `git status` will continue running in the background, so after a few moments, hitting `<Enter>` again should give you an up-to-date summary.
48-
49-
> `(s)` is a reminder that the top stash was made on the current branch, or the current commit.
35+
![Git Branch in Prompt](https://github.com/joeytwiddle/git-aware-prompt/raw/master/preview.png)
36+
37+
> `` is a reminder that I have something on the stash.
38+
>
39+
> `<3` indicates that the local branch is 3 commits behind the upstream (remote) branch, and could/should be pulled.
40+
>
41+
> `?1` indicates that there is 1 untracked file in the tree.
42+
>
43+
> `+1` indicates that one file is staged for comitting.
44+
>
45+
> `>1` indicates that the local branch has 1 commit which has not yet been pushed to the upstream.
46+
>
47+
> `*1` indicates that the branch is dirty, with 1 file modified but not committed.
48+
>
49+
> `#` would indicate that `git status` has taken too long, so the markers are not shown.
50+
>
51+
> 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.
5052
5153
We also have some indicators for the current branch:
5254

5355
> `[branch_name]` means you are on a branch with an upstream
54-
56+
>
5557
> `(branch_name)` means you are on a branch without an upstream
56-
58+
>
5759
> `{branch_name\mode}` means you are in the middle of a merge, rebase, cherry-pick, revert or bisect
58-
59-
> `<commit_id>` means you are detached on the given commit
60+
>
61+
> `<commit_id>` means you are detached on the given commit, tag, or remote branch
6062
6163
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.
6264

preview.png

119 KB
Loading

0 commit comments

Comments
 (0)