Skip to content

Commit 6efd319

Browse files
tomekwSevereOverfl0w
authored andcommitted
Describe usage in the README
I know `doc/jack_in.txt` is a way to go, but sometimes it's nice to take a quick look at the README to assess the library.
1 parent a89a333 commit 6efd319

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.adoc

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,47 @@ Plug 'clojure-vim/vim-jack-in'
1111
" Only in Neovim:
1212
Plug 'radenling/vim-dispatch-neovim'
1313
----
14+
15+
Provides a couple of helper commands for "jacking" in to a Clojure REPL by
16+
auto-starting it. Highly inspired by CIDER.el's feature by the same name.
17+
18+
== Commands
19+
20+
These run inside the directory vim is currently in. In the future it would be
21+
nice to run relative to the current file.
22+
To run boot & lein, `dispatch-:Start` is used with the bang option.
23+
24+
=== Boot
25+
[source]
26+
----
27+
:Boot [args]
28+
----
29+
Start boot with CIDER-nrepl and Refactor-nrepl automatically injected.
30+
[args] is a list of tasks to run in boot. If not provided,
31+
`g:default_boot_task` is used instead.
32+
33+
=== Clj
34+
[source]
35+
----
36+
:Clj [args]
37+
----
38+
Start clj with CIDER-nrepl and Refactor-nrepl automatically injected.
39+
[args] is a list of options to run in clj. If not provided,
40+
no aditional options will be used.
41+
42+
=== Lein
43+
[source]
44+
----
45+
:Lein [args]
46+
----
47+
Start lein with CIDER-nrepl and Refactor-nrepl automatically injected.
48+
[args] is a list of tasks to run in lein. If not provided,
49+
`g:default_lein_task` is used instead.
50+
51+
== Variables
52+
53+
`g:default_boot_task`
54+
Control the default task to start boot with. Defaults to "repl"
55+
56+
`g:default_lein_task`
57+
Control the default task to start lein with. Defaults to "repl"

0 commit comments

Comments
 (0)