diff --git a/README.md b/README.md index afde037..2b5b8aa 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@

Cursor jump for tmux.

[![Build Status](https://travis-ci.org/schasse/tmux-jump.svg?branch=master)](https://travis-ci.org/schasse/tmux-jump) -A fast way to jump wherever you want in your terminal without using the mouse. tmux-jump is written in ruby and can easily be installed via tpm. +A fast way to jump wherever you want in your terminal without using the mouse. A plugin similar to [vimium](https://vimium.github.io/) and [easymotion](https://github.com/easymotion/vim-easymotion) but for tmux. tmux-jump is written in ruby and can easily be installed via tpm. ![tmux-jump](assets/tmux-jump-demo.gif) @@ -14,29 +14,49 @@ From now to then I think about how to improve my dev tools. Copy and pasting ins ## Requirements -* [tpm](https://github.com/tmux-plugins/tpm) -* ruby +* [tmux](https://github.com/tmux/tmux) >= 1.8 +* [ruby](https://www.ruby-lang.org/) >= 2.3 -## Installation +## Installation with [TPM](https://github.com/tmux-plugins/tpm) Add plugin to the list of TPM plugins in `~/.tmux.conf`: ``` set -g @plugin 'schasse/tmux-jump ``` -Hit `tmux-prefix` + I to fetch the plugin and source it. You should now be able to use the plugin. +Hit tmux-prefix + I to fetch the plugin and source it. You should now be able to use the plugin. + +## Manual Installation + +Clone the repository: + +``` +git clone https://github.com/schasse/tmux-jump ~/.tmux-jump +``` + +Add the following to `.tmux.conf`: + +``` +run-shell ~/.tmux-jump/tmux-jump.tmux +``` + +Reload tmux: + +``` +tmux source-file ~/.tmux.conf +``` ## Usage -* `tmux-prefix` + j and enter the first character of a word. +* tmux-prefix + j and enter the first character of a word. * The screen will rerender and highlight the keys to press to jump to the word. * Type the key sequence of the word to jump to. * The cursor moves to the word. -tmux-jump can also be used in copy mode. +tmux-jump can also be used in in any program and during copy mode. ## Similar Projects -[easymotion](https://github.com/easymotion/vim-easymotion) - -[ace-jump-mode](https://github.com/winterTTr/ace-jump-mode) +* [vimium](https://vimium.github.io/) +* [easymotion](https://github.com/easymotion/vim-easymotion) +* [ace-jump-mode](https://github.com/winterTTr/ace-jump-mode)