Skip to content

Commit 2e1dd6c

Browse files
committed
Update the "Usage" section of the README
1 parent d04c36c commit 2e1dd6c

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,22 @@ result will be nothing short of havoc.**
5454

5555
`M-x inf-clojure` or `C-c C-z` within a Clojure source file.
5656

57-
`inf-clojure-program` is a custom variable that defines a program to run
58-
or the tcp socket to connect to when starting `inf-clojure`. By default
59-
this variable is set to `lein repl`, which will start a REPL via Leiningen.
60-
However, it is possible to use a cons pair like `("localhost" . 5555)` to
61-
connect to a socket REPL like the one provided with [planck](http://planck-repl.org/),
62-
which can be started from the command line with `planck -n 5555`.
57+
`inf-clojure` has several custom variables which control the command
58+
used to start a REPL for particular project type - `inf-clojure-lein-cmd`,
59+
`inf-clojure-boot-cmd` and `inf-clojure-generic-cmd`.
60+
61+
By default all those variables are set to strings (e.g. `lein repl`).
62+
However, it is possible to use a cons pair like `("localhost" . 5555)`
63+
to connect to a socket REPL like the one provided
64+
with [planck](http://planck-repl.org/), which can be started from the
65+
command line with `planck -n 5555`.
6366

6467
Use `C-u C-c C-z` to start a REPL with a different command/cons pair than
6568
the default specified in `inf-clojure-program`.
6669

70+
You can set custom values to `inf-clojure` variables on a per-project basis using [directory
71+
variables](https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html).
72+
6773
## ElDoc
6874

6975
`eldoc-mode` is supported in Clojure source buffers and `*inferior-clojure*`

0 commit comments

Comments
 (0)