Skip to content

Commit 37cfe85

Browse files
committed
Update some wording
Support for terminal REPLs is not going to be deprecated.
1 parent 1e99b82 commit 37cfe85

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -217,22 +217,23 @@ If you want to update a specific form there is a function
217217

218218
#### Caveats
219219

220-
It is highly recommended to use a cons pair like `("localhost" . 5555)` to
221-
connect to a socket REPL, terminal REPLs are inherently hard to work with and
222-
support will be deprecated in the foreseeable future. If you use the
223-
same project often, make a `.dir-locals.el` file with this information in `inf-clojure-custom-startup`.
224-
225-
Note that if you decide _NOT_ to use the socket REPL, it is highly recommended
226-
you disable output coloring and/or readline facilities: `inf-clojure` does not
220+
As `inf-clojure` is built on top of `comint` it has all the usual comint limitations -
221+
namely it can't handle well some fancy terminal features (e.g. ANSI colours).
222+
In general the "dumber" your terminal REPL is, the better (e.g. `clojure` vs `clj`).
223+
Connecting to a socket REPL is one simple way to avoid dealing with this type of
224+
problems.
225+
226+
If you decide _not_ to use the socket REPL, it is highly recommended
227+
you disable output coloring and/or `readline` facilities: `inf-clojure` does not
227228
filter out ASCII escape characters at the moment and will not behave correctly.
228229

229-
For leiningen, there are no command line switches and you need to add
230+
For Leiningen, there are no command-line switches and you need to add
230231
a custom [`project.clj`
231232
option](https://github.com/technomancy/leiningen/blob/master/sample.project.clj):
232233

233234
```clojure
234235
...
235-
:repl-options {:color false}
236+
:repl-options {:color false}
236237
...
237238
```
238239

0 commit comments

Comments
 (0)