holm/ohmyzsh
1
1
Fork 0
forked from extern/ohmyzsh
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #4619 from apjanke/mercurial-readme-tweak

Browse Source 
Mercurial plugin: revise README
This commit is contained in:
Marc Cornellà 2015-11-20 16:40:47 +01:00
commit c120417336
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
plugins/mercurial/README.md
View File

@ -2,21 +2,18 @@
### Usage ### Usage
Update .zshrc: Update .zshrc:
1. Add name to the list of plugins, e.g. `plugins = (..., mercurial, ...)` 1. Add name to the list of plugins, e.g. `plugins=(... mercurial ...)`
(that is pretty obvious). (that is pretty obvious).
2. Change PROMPT variable of current theme to contain current folder mercurial repo info: 2. Switch to a theme which uses `hg_prompt_info`.
robbyrussel theme is used by default, so you need to modify PROMPT var Or, customize the `$PROMPT` variable of your current theme to contain current folder mercurial repo info. This can be done by putting a custom version of the theme in `$ZSH_CUSTOM` or by changing `$PROMPT` in `.zshrc` after loading the theme.
from [this file](https://github.com/robbyrussell/oh-my-zsh/blob/master/themes/robbyrussell.zsh-theme)
by adding `$(hg_prompt_info)` after `$(git_prompt_info)`, so currently it
looks next:
```diff The `robbyrussell` theme is used by default, so you need to modify `$PROMPT` var by adding `$(hg_prompt_info)` after `$(git_prompt_info)`, so it looks like this:
- PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}'
+ PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)$(hg_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}' ```zsh
PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)$(hg_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}'
``` ```
and put modified var at the end of **.zshrc**.
3. Initialize additional vars used in plugin. So in short put next in **.zshrc**: 3. Initialize additional vars used in plugin. So in short put next in **.zshrc**:
``` ```
@ -55,8 +52,7 @@ Update .zshrc:
#### Displays repo branch and directory status in prompt #### Displays repo branch and directory status in prompt
This is the same as git plugin does. This is the same as git plugin does.
**Note**: additional changes to **.zshrc** are required in order for this to **Note**: Additional changes to **.zshrc**, or using a theme designed to use `hg_prompt_info`, are required in order for this to work.
work.
### Mantainers ### Mantainers
[ptrv](https://github.com/ptrv) - original creator [ptrv](https://github.com/ptrv) - original creator