Skip to content

Commit f1c27de

Browse files
committed
docs: Promote usage links in readme and remove help doc specific copy
1 parent cac9d11 commit f1c27de

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Vimux was originally inspired by [tslime.vim](https://github.com/jgdavey/tslime.
88

99
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 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`.
1010

11-
Other auxiliary functions and the ones talked about above can be found below with full descriptions and example key bindings for your vimrc.
12-
1311
## Installation
1412

1513
With **[vim-bundle](https://github.com/preservim/vim-bundle)**: `vim-bundle install preservim/vimux`
@@ -19,7 +17,11 @@ Otherwise download the latest [tarball](https://github.com/preservim/vimux/tarba
1917

2018
_Notes:_
2119

22-
* Vimux assumes a tmux version >= 1.5. Some older versions might work but it is recommended to use at least version 1.5.
20+
* Vimux assumes a reasonably new version of tmux. Some older versions might work but it is recommended to use the latest stable release.
21+
22+
## Usage
23+
24+
The full documentation is available [online](https://raw.github.com/preservim/vimux/master/doc/vimux.txt) and accessible inside vim via `:help vimux`
2325

2426
## Platform-specific Plugins
2527

@@ -35,7 +37,3 @@ _Notes:_
3537
* [vimux-cargo](https://github.com/jtdowney/vimux-cargo) run rust tests and projects using cargo and vimux
3638
* [vimux-bazel-test](https://github.com/pgr0ss/vimux-bazel-test) Run bazel tests in vimux
3739
* [vimux-jest-test](https://github.com/tyewang/vimux-jest-test) Run jest tests in vimux
38-
39-
## Usage
40-
41-
The full documentation is available [online](https://raw.github.com/preservim/vimux/master/doc/vimux.txt) and accessible inside vim `:help vimux`

0 commit comments

Comments
 (0)