Permalink
Browse files

Update README.mkd

  • Loading branch information...
1 parent 31b174f commit 2ba3baec13387672b831b56a242364e5327872f3 @benmills benmills committed Mar 3, 2012
Showing with 6 additions and 0 deletions.
  1. +6 −0 README.mkd
View
@@ -2,6 +2,12 @@
Easily interact with tmux from vim. This project is still in development, so some features are still missing.
+What inspired me to write vimux was [tslime.vim](https://github.com/kikijump/tslime.vim), 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.
+
+My goal with vimux is to make interacting with tmux from vim effortless. By default when you call `RunVimTmuxCommand` 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 `RunVimTmuxCommand` 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 `RunLastVimTmuxCommand` that will execute the last command you called with `RunVimTmuxCommand`.
+
+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.
+
## Installation
With **[vim-bundle](https://github.com/benmills/vim-bundle)**: `vim-bundle install benmills/vimux`

0 comments on commit 2ba3bae

Please sign in to comment.