diff options
| author |   Biswakalyan Bhuyan <biswa@surgot.in>
| 2024-03-25 16:43:09 +0530 |
|---|---|---|
| committer | Biswakalyan Bhuyan <biswa@surgot.in>
| 2024-03-25 16:43:09 +0530 |
| commit | a62114c91f2070c8c8453d117f3d81dc113e41ff (patch) | |
| tree | f266e87af29a08c01f82bc32dd7d463d8ec4441a /zsh/oh-my-zsh/plugins/git-prompt/README.md | |
| parent | af120ab348f2e1a5a39dec035ed9dcf84189a64e (diff) | |
| download | dotfiles-a62114c91f2070c8c8453d117f3d81dc113e41ff.tar.gz dotfiles-a62114c91f2070c8c8453d117f3d81dc113e41ff.tar.bz2 dotfiles-a62114c91f2070c8c8453d117f3d81dc113e41ff.zip | |
dotfile update
Diffstat (limited to 'zsh/oh-my-zsh/plugins/git-prompt/README.md')
| -rw-r--r-- | zsh/oh-my-zsh/plugins/git-prompt/README.md | 66 |
1 files changed, 0 insertions, 66 deletions
diff --git a/zsh/oh-my-zsh/plugins/git-prompt/README.md b/zsh/oh-my-zsh/plugins/git-prompt/README.md deleted file mode 100644 index 8775af8..0000000 --- a/zsh/oh-my-zsh/plugins/git-prompt/README.md +++ /dev/null @@ -1,66 +0,0 @@ -# git-prompt plugin - -A `zsh` prompt that displays information about the current git repository. In particular: -the branch name, difference with remote branch, number of files staged or changed, etc. - -To use it, add `git-prompt` to the plugins array in your zshrc file: - -```zsh -plugins=(... git-prompt) -``` - -See the [original repository](https://github.com/olivierverdier/zsh-git-prompt). - -## Requirements - -This plugin uses `python3`, so your host needs to have it installed. - -## Examples - -The prompt may look like the following: - -- `(master↑3|✚1)`: on branch `master`, ahead of remote by 3 commits, 1 file changed but not staged -- `(status|●2)`: on branch `status`, 2 files staged -- `(master|✚7…)`: on branch `master`, 7 files changed, some files untracked -- `(master|✖2✚3)`: on branch `master`, 2 conflicts, 3 files changed -- `(experimental↓2↑3|✔)`: on branch `experimental`; your branch has diverged by 3 commits, remote by 2 commits; the repository is otherwise clean -- `(:70c2952|✔)`: not on any branch; parent commit has hash `70c2952`; the repository is otherwise clean -- `(master|⚑2)`: on branch `master`, there are 2 stashed changes - -## Prompt Structure - -By default, the general appearance of the prompt is: - -```text -(<branch><branch tracking>|<local status>) -``` - -The symbols are as follows: - -### Local Status Symbols - -| Symbol | Meaning | -|--------|--------------------------------| -| ✔ | repository clean | -| ●n | there are `n` staged files | -| ✖n | there are `n` unmerged files | -| ✚n | there are `n` unstaged files | -| ⚑n | there are `n` stashed changes | -| … | there are some untracked files | - -### Branch Tracking Symbols - -| Symbol | Meaning | -|--------|---------------------------------------------------------------| -| ↑n | ahead of remote by `n` commits | -| ↓n | behind remote by `n` commits | -| ↓m↑n | branches diverged: other by `m` commits, yours by `n` commits | - -## Customisation - -- Set the variable `ZSH_THEME_GIT_PROMPT_CACHE` to any value in order to enable caching. -- You may also change a number of variables (whose name start with `ZSH_THEME_GIT_PROMPT_`) - to change the appearance of the prompt. Take a look at the bottom of the [plugin file](git-prompt.plugin.zsh)` - to see what variables are available. - -**Enjoy!** |