diff --git a/doc/vimux.txt b/doc/vimux.txt index 0770a33..dff0dcd 100644 --- a/doc/vimux.txt +++ b/doc/vimux.txt @@ -28,25 +28,24 @@ ABOUT (1) *VimuxAbout* Vimux -- Easily interact with tmux from vim. -What inspired me to write vimux was tslime.vim [1], a plugin that lets you -send input to tmux. While tslime.vim works well, I felt it wasn't optimized -for my primary use case which was having a smaller tmux pane that I would use -to run tests or play with a REPL. +Vimux was originally inspired by tslime.vim [1], a plugin that lets you send +input to tmux. While tslime.vim works well, it wasn't optimized for the use +case of having a smaller tmux pane used to run tests or play with a REPL. The +goal of Vimux is to make interacting with tmux from vim effortless. -My goal with vimux is to make interacting with tmux from vim effortless. By -default when you call `VimuxRunCommand` vimux will create a 20% tall +By default, when you call `VimuxRunCommand` vimux will create a 20% tall horizontal pane under your current tmux pane and execute a command in it -without losing focus of vim. Once that pane exists whenever you call -`VimuxRunCommand` again the command will be executed in that pane. As I was -using vimux myself I wanted to rerun commands over and over. An example of -this was running the current file through rspec. Rather than typing that over -and over I wrote `VimuxRunLastCommand` that will execute the last command -you called with `VimuxRunCommand`. +without losing the focus on vim. Once that pane exists, whenever you call +`VimuxRunCommand` again the command will be executed in that pane. A frequent +use case is wanting to rerun commands over and over. An example of this is +running the current file through rspec. Rather than typing that over and over +`VimuxRunLastCommand` will execute the last command called with +`VimuxRunCommand`. -Other auxiliary functions and the ones I talked about above can be found -bellow with a full description and example key binds for your vimrc. +Other auxiliary functions and the ones talked about above can be found bellow +with full descriptions and example key bindings for your vimrc. -[1] https://github.com/kikijump/tslime.vim +[1] https://github.com/jgdavey/tslime.vim/network ==============================================================================