tmux-golden-apple

pomodoro timer tmux plugin
git clone git://git.pyratebeard.net/tmux-golden-apple.git
Log | Files | Refs | README

README.md (1086B)


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