Skip to content

Commit 58150d7

Browse files
committed
Improve some wording in the README
1 parent 1ba6416 commit 58150d7

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -136,39 +136,42 @@ for the symbol you want to show the docstring for.
136136

137137
## Configuration
138138

139-
## Most Common Configuration
139+
**Note:** The configuration options were changed massively in `inf-clojure` 3.0.
140+
141+
In the time-honoured Emacs tradition `inf-clojure`'s behaviour is extremely
142+
configurable.
143+
144+
You can set custom values to `inf-clojure` variables on a
145+
per-project basis using [directory
146+
variables](https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html)
147+
or by setting them in in your init file.
148+
149+
You can see all the configuration options available using the command
150+
`M-x customize-group RET inf-clojure`.
151+
152+
### Startup
140153

141154
Most likely you will want to set the startup command and the repl
142-
type. This is most easily set with the follow dir-locals
155+
type. This is most easily set with the following `dir-locals.el`:
143156

144157
```emacs-lisp
145158
((nil
146159
(inf-clojure-custom-startup . "clojure -A:compliment")
147160
(inf-clojure-custom-repl-type . clojure)))
148161
```
149162

150-
There are two important commands here:
151-
1. `inf-clojure-custom-startup`: Which startup command to use so
152-
inf-clojure can run the inferior process and
153-
2. `inf-clojure-custom-repl-type`: Which repl type it is so
154-
inf-clojure knows how to format commands to the repl
163+
**Note:** This file has to be in the directory in which you're invoking `inf-clojure`.
155164

156-
If these are set and you wish to prevent inf-clojure from using them,
157-
use a prefix arg when invoking `inf-clojure`.
158-
159-
### All Configuration
160-
**Note:** The configuration options were changed massively in `inf-clojure` 3.0.
165+
There are two important configuration variables here:
161166

162-
In the time-honoured Emacs tradition `inf-clojure`'s behaviour is extremely
163-
configurable.
167+
1. `inf-clojure-custom-startup`: Which startup command to use so
168+
inf-clojure can run the inferior Clojure process (REPL).
169+
2. `inf-clojure-custom-repl-type`: The type of the REPL started by the above command (e.g. `lumo`).
164170

165-
You can set custom values to `inf-clojure` variables on a
166-
per-project basis using [directory
167-
variables](https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html)
168-
or by setting them in in your init file.
171+
If these are set and you wish to prevent inf-clojure from using them,
172+
use a prefix arg when invoking `inf-clojure` (`C-u M-x inf-clojure`).
169173

170-
You can see all the configuration options available using the command
171-
`M-x customize-group RET inf-clojure`.
174+
### REPL Features
172175

173176
The supported REPL-features are in an alist called
174177
`inc-clojure-repl-features` and it has the following shape:

0 commit comments

Comments
 (0)