Skip to content

Commit f519564

Browse files
committed
Add Caveats section to README
1 parent 8c2a0ef commit f519564

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,26 @@ point. You can, however, change this behaviour by invoking such
9999
commands with a prefix argument. For instance: `C-u C-c C-v` will ask
100100
for the symbol you want to show the docstring for.
101101

102+
#### Caveats
103+
104+
Note that if you decide _NOT_ to use the socket repl, it is highly recommended
105+
you disable output coloring and/or readline facilities: `inf-clojure` does not
106+
filter out ASCII escape characters at the moment and will not behave correctly.
107+
108+
You can disable coloring the following way for `boot`:
109+
110+
```el
111+
((nil . ((inf-clojure-boot-cmd . "boot repl -C"))))
112+
```
113+
114+
For leiningen, there are no command line switches and you need to add a custom [`project.clj` option](https://github.com/technomancy/leiningen/blob/master/sample.project.clj):
115+
116+
```clojure
117+
...
118+
:repl-options {:color false}
119+
...
120+
```
121+
102122
## Configuration options
103123

104124
In the time-honoured Emacs tradition `inf-clojure`'s behaviour is extremely

0 commit comments

Comments
 (0)