README.md (1086B)
1 # tmux golden apple 2 3 A simple Pomodoro timer for your tmux statusline 4 5 ## Installation 6 ### With [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended) 7 Add the plugin to your list of TPM plugins in `.tmux.conf` 8 ``` 9 set -g @plugin 'https://gitlab.com/pyratebeard/tmux-golden-apple.git' 10 ``` 11 12 Fetch the plugin and source it using `prefix + I`. 13 14 ### Manual installation 15 Clone the repo 16 ``` 17 git clone https://gitlab.com/pyratebeard/tmux-golden-apple.git ~/.tmux/plugins/ 18 ``` 19 20 Reload your Tmux environment by typing the following in the terminal 21 ``` 22 tmux source-file ~/.tmux.conf 23 ``` 24 25 ## Usage 26 Add the format string `#{goldenapple}` in to your `status-right` or `status-left` option. 27 28 Add the following bind-key options 29 ``` 30 bind-key g run-shell "~/.tmux/plugins/tmux-golden-apple/golden_apple.tmux start" 31 bind-key G run-shell "~/.tmux/plugins/tmux-golden-apple/golden_apple.tmux stop" 32 ``` 33 34 By default the timer will run for 15 minutes. 35 You can modify the timer using the option `@work`, for example to set it for 30 minutes: 36 ``` 37 set -g @work 30 38 ``` 39 40 ## License 41 [MIT](LICENSE)