Skip to content

Commit b744060

Browse files
author
Greg Lazarev
committed
Update documentation to reflect runner changes
1 parent 0a6c562 commit b744060

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -50,32 +50,33 @@ Or, [Dispatch](https://github.com/tpope/vim-dispatch) and
5050
let g:rspec_command = "compiler rspec | set makeprg=zeus | Make rspec {spec}"
5151
```
5252

53-
### Custom runners
53+
### MacVim command runners
5454

55-
Overwrite the `g:rspec_runner` variable to set a custom launch script. At the
56-
moment there are two MacVim-specific runners, i.e. `os_x_terminal` and
57-
`os_x_iterm`. The default is `os_x_terminal`, but you can set this to anything
58-
you want, provided you include the appropriate script inside the plugin's
59-
`bin/` directory.
55+
If you are running your specs from MacVim,
56+
you must set `g:rspec_runner` or `g:rspec_command`, or both.
6057

61-
#### iTerm instead of Terminal
62-
63-
If you use iTerm, you can set `g:rspec_runner` to use the included iterm
64-
launching script. This will run the specs in the last session of the current
65-
terminal.
58+
The `g:rspec_runner` variable specifies which launch script will be used:
6659

6760
```vim
6861
let g:rspec_runner = "os_x_iterm"
6962
```
7063

71-
If you use the iTerm2 nightlies, the `os_x_iterm` runner will not work
72-
(due to AppleScript incompatibilities between the old and new versions of iTerm2).
64+
At the moment the following MacVim-specific runners are supported:
7365

74-
Instead use the `os_x_iterm2` runner, configure it like so:
66+
* `os_x_terminal` for OSX Terminal.app
67+
* `os_x_iterm` for iTerm2 stable release
68+
* If you use the iTerm2 nightlies,
69+
this runner will not work due to AppleScript incompatibilities
70+
between the old and new versions of iTerm2
71+
* `os_x_iterm2` for iTerm2 nightly builds
7572

76-
```vim
77-
let g:rspec_runner = "os_x_iterm2"
78-
```
73+
If `g:rspec_runner` isn't set,
74+
the `g:rspec_command` will be executed from MacVim without a runner.
75+
This enables commands like `Dispatch rspec {spec}` to work in GUI mode.
76+
77+
You can set `g:rspec_runner` to anything you want,
78+
provided you include the appropriate script
79+
inside the plugin's `bin/` directory.
7980

8081
## Running tests
8182

0 commit comments

Comments
 (0)