Skip to content

Commit 917ee77

Browse files
committed
Improve the README a bit
1 parent d7eb9ce commit 917ee77

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ You can see all the configuration options available using the command
151151

152152
### Startup
153153

154-
While `inf-clojure` is capable of starting many common REPLs out of the box it's
154+
While `inf-clojure` is capable of starting many common REPLs out of the box, it's
155155
fairly likely you will want to set some custom REPL startup command
156156
(e.g. because you need to include some `tools.deps` profile) and the REPL type
157157
that goes with it. This is most easily achieved with the following `dir-locals.el`:
@@ -162,7 +162,8 @@ that goes with it. This is most easily achieved with the following `dir-locals.e
162162
(inf-clojure-custom-repl-type . clojure)))
163163
```
164164

165-
**Note:** This file has to be in the directory in which you're invoking `inf-clojure`.
165+
**Note:** This file has to be in the directory in which you're invoking `inf-clojure` or a parent
166+
directory.
166167

167168
There are two important configuration variables here:
168169

@@ -235,8 +236,8 @@ If you have the new [Clojure CLI tools][] installed you can use the `clojure` co
235236

236237
_do not use `clj` because it adds readline support_
237238

238-
```shell
239-
clojure -J-Dclojure.server.repl="{:port 5555 :accept clojure.core.server/repl}"
239+
``` shellsession
240+
$ clojure -J-Dclojure.server.repl="{:port 5555 :accept clojure.core.server/repl}"
240241
```
241242

242243
Then either `C-c M-c RET localhost RET 5555` from within Emacs or add the following to your `.dir-locals.el`:
@@ -260,6 +261,7 @@ information on how connect:
260261
```emacs-lisp
261262
((nil (inf-clojure-custom-startup "localhost" . 5555)))
262263
```
264+
263265
The socket server REPL configuration options are described [here](https://clojure.org/reference/repl_and_main#_launching_a_socket_server).
264266

265267
#### Lumo Socket REPL
@@ -270,6 +272,10 @@ For example if a `project.clj` is present in the project root folder, `inf-cloju
270272

271273
After you launch `lumo ... -n 5555`, as customary, either `C-c M-c RET localhost RET 5555` from within Emacs or add the following to your `.dir-locals.el`:
272274

275+
```emacs-lisp
276+
((nil (inf-clojure-custom-startup "localhost" . 5555)))
277+
```
278+
273279
#### Multiple Process Support
274280

275281
To run multiple Clojure processes, you start the first up
@@ -328,6 +334,9 @@ startup when using the `inf-clojure` command or is specified manually when using
328334

329335
#### ElDoc
330336

337+
**Note:** You can skip this section if you're using Emacs 26.1+, as `eldoc-mode`
338+
is enabled by default there.
339+
331340
`eldoc-mode` is supported in Clojure source buffers and `*inferior-clojure*`
332341
buffers which are running a Clojure REPL.
333342

0 commit comments

Comments
 (0)