Skip to content

Commit 055e87f

Browse files
Update README.md (#70)
* Update README.md Updated the README with clearer information: - an information about the refresh time -- I almost created a bug, because I'm a beginner on tmux and I didn't know this variable; so I think that an informative line about this can be useful - a modification of an example that I didn't find necessarily clear because it didn't use the same context as the example given in the "Getting started" section * Update README.md Improve the line about status-interval
1 parent 9f9de9b commit 055e87f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,12 @@ you run or when you switch windows, however it won't refresh automatically, nor
5757

5858
Note that `tmux v2.1` was released in 2015 so you're probably better off updating to a more recent version anyway 🙂.
5959

60+
In case gitmux takes too long to refresh, try to decrease the value of the `status-interval` option. A reasonable value is 2 seconds, which you can set in `.tmux.conf` with:
61+
62+
set -g status-interval 2
63+
64+
Check out [tmux man page](https://www.man7.org/linux/man-pages/man1/tmux.1.html#OPTIONS) for more details.
65+
6066
## Customizing
6167

6268
`gitmux` output can be customized via a configuration file in YAML format.
@@ -98,9 +104,9 @@ First, save the default configuration to a new file:
98104
99105
gitmux -printcfg > .gitmux.conf
100106
101-
Modify the line in `.tmux.conf`, passing the path of the configuration file as argument to `gitmux`
107+
Modify the line in `.tmux.conf`, passing the path of the configuration file as argument to `gitmux` via the `-cfg` flag
102108

103-
gitmux -cfg .gitmux.conf
109+
set -g status-right '#(gitmux -cfg .gitmux.conf "#{pane_current_path}")'
104110

105111
Open `.gitmux.conf` and modify it, replacing symbols, styles and layout to suit your needs.
106112

@@ -222,7 +228,6 @@ This is the list of additional configuration `options`:
222228

223229
Please report anything by [filing an issue](https://github.com/arl/gitmux/issues/new).
224230

225-
226231
## Contributing
227232

228233
Pull requests are welcome.

0 commit comments

Comments
 (0)