cca422eacfb0d418af00c7df9dc97639b65a1eca

Author
Andrew Janke <andrew@apjanke.net>
Committer
Andrew Janke <andrew@apjanke.net>
Date

Message

Mercurial plugin: revise README

Closes #4616
Changes the `plugins=(... mercurial ...)` to be closer to correct zsh syntax, removing commas and extra spaces.
Revises discussion on configuring themes to avoid sounding like users should modify the theme definition file in the main OMZ folder. Prioritizes the suggestion of using a theme which already supports hg_prompt_info.

Diff

 1diff --git a/plugins/mercurial/README.md b/plugins/mercurial/README.md
 2index 89e1c17431b53ed996c9121baec858007c7de69a..f42212d688371db297abd5569bcaf6f367d834ac 100644
 3--- a/plugins/mercurial/README.md
 4+++ b/plugins/mercurial/README.md
 5@@ -2,23 +2,20 @@
 6 ### Usage
 7 Update .zshrc:
 8 
 9-1. Add name to the list of plugins, e.g. `plugins = (..., mercurial, ...)`
10+1. Add name to the list of plugins, e.g. `plugins=(... mercurial ...)`
11    (that is pretty obvious).
12-2. Change PROMPT variable of current theme to contain current folder mercurial repo info:
13+2. Switch to a theme which uses `hg_prompt_info`.
14 
15-   robbyrussel theme is used by default, so you need to modify PROMPT var
16-   from [this file](https://github.com/robbyrussell/oh-my-zsh/blob/master/themes/robbyrussell.zsh-theme)
17-   by adding `$(hg_prompt_info)` after `$(git_prompt_info)`, so currently it
18-   looks next:
19+   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.
20 
21-   ```diff
22-   - PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}'
23-   + PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)$(hg_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}'
24+   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:
25+
26+   ```zsh
27+   PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)$(hg_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}'
28    ```
29-   
30-   and put modified var at the end of **.zshrc**.
31+
32 3. Initialize additional vars used in plugin. So in short put next in **.zshrc**:
33-   
34+
35    ```
36    ZSH_THEME_HG_PROMPT_PREFIX="%{$fg_bold[magenta]%}hg:(%{$fg[red]%}"
37    ZSH_THEME_HG_PROMPT_SUFFIX="%{$reset_color%}"
38@@ -55,8 +52,7 @@ Update .zshrc:
39 #### Displays repo branch and directory status in prompt
40 This is the same as git plugin does.
41 
42-**Note**: additional changes to **.zshrc** are required in order for this to
43-work.
44+**Note**: Additional changes to **.zshrc**, or using a theme designed to use `hg_prompt_info`, are required in order for this to work.
45 
46 ### Mantainers
47 [ptrv](https://github.com/ptrv) - original creator