adjust readme

This commit is contained in:
schasse 2020-02-01 23:32:32 +01:00
parent d8195cf493
commit d04b8ce31d
No known key found for this signature in database
GPG key ID: 5497EFF3E3E1CACD

View file

@ -1,9 +1,16 @@
# tmux-easymotion
<p align="center">
<img src="assets/tmux-jump-logo.png"
alt="Cursor jump for tmux."
title="tmux-jump" />
</p>
[![Build Status](https://travis-ci.org/schasse/tmux-easymotion.svg?branch=master)](https://travis-ci.org/schasse/tmux-easymotion)
[easymotion](https://github.com/easymotion/vim-easymotion) for tmux.
![tmux-jump](assets/ttmux-jump-demo.gif)
![tmux-easymotion](https://user-images.githubusercontent.com/3882305/65063780-7390a500-d96e-11e9-98b3-7647892764ab.gif)
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.
From now to then I think about how to improve my dev tools. Copy and pasting inside the Terminal is something I do everyday, all the time. This is one of the most obvious things make more efficient. tmux-yank improved the situation a lot. Though, it felt still annoying to get to the string I wanted to copy. Either I used to enter tmux copy mode and moved the cursor to the string or I used the mouse. I looked for a plugin such as easymotion for vim or ace jump for emacs, but I couldn't find one. So I decided to write my own tmux plugin.
## Requirements
@ -15,11 +22,20 @@
Add plugin to the list of TPM plugins in `~/.tmux.conf`:
```
set -g @plugin 'schasse/tmux-easymotion'
set -g @plugin 'schasse/tmux-jump
```
Hit `tmux-prefix` + <kbd>I</kbd> to fetch the plugin and source it. You should now be able to use the plugin.
## Usage
* `tmux-prefix` + <kbd>j</kbd>
* `<first letter of the word to jump to>`
* `tmux-prefix` + <kbd>j</kbd> 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.
## Similar Projects
[easymotion](https://github.com/easymotion/vim-easymotion)
[ace-jump-mode](https://github.com/winterTTr/ace-jump-mode)