Skip to content

Commit 6bf4295

Browse files
committed
Tweak the README markup a bit
1 parent 6833bb8 commit 6bf4295

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,18 @@ It supports the following REPLs:
4040
`inf-clojure` provides a set of essential features for interactive
4141
Clojure/ClojureScript/ClojureCLR development:
4242

43-
* Enhanced REPL
44-
* Interactive code evaluation
45-
* Code completion
46-
* Definition lookup
47-
* Documentation lookup
48-
* ElDoc
49-
* Apropos
50-
* Macroexpansion
51-
* Reloading a namespace (via `require :reload`/`require :reload-all`)
52-
* Connecting to socket REPLs
53-
54-
For a more powerful/full-featured solution see [CIDER](https://github.com/clojure-emacs/cider).
43+
- Enhanced REPL
44+
- Interactive code evaluation
45+
- Code completion
46+
- Definition lookup
47+
- Documentation lookup
48+
- ElDoc
49+
- Apropos
50+
- Macroexpansion
51+
- Reloading a namespace (via `require :reload`/`require :reload-all`)
52+
- Connecting to socket REPLs
53+
54+
For a more powerful/full-featured solution see [CIDER][].
5555

5656
## Rationale
5757

@@ -156,7 +156,7 @@ configurable.
156156
You can set custom values to `inf-clojure` variables on a
157157
per-project basis using [directory
158158
variables](https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html)
159-
or by setting them in in your init file.
159+
or by setting them in in your [init file][Emacs init file].
160160

161161
You can see all the configuration options available using the command
162162
`M-x customize-group RET inf-clojure`.
@@ -245,7 +245,7 @@ If you decide _not_ to use the socket REPL, it is highly recommended
245245
you disable output coloring and/or `readline` facilities: `inf-clojure` does not
246246
filter out ASCII escape characters at the moment and will not behave correctly.
247247

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

@@ -261,15 +261,16 @@ If you have the new [Clojure CLI tools][] installed you can use the `clojure` co
261261

262262
_do not use `clj` because it adds readline support_
263263

264-
``` shellsession
265-
$ clojure -J-Dclojure.server.repl="{:port 5555 :accept clojure.core.server/repl}"
264+
``` shell
265+
clojure -J-Dclojure.server.repl="{:port 5555 :accept clojure.core.server/repl}"
266266
```
267267

268268
Then either `C-c M-c RET localhost RET 5555` from within Emacs or add the following to your `.dir-locals.el`:
269269

270270
```emacs-lisp
271271
((nil . ((inf-clojure-custom-startup . ("localhost" . 5555)))))
272272
```
273+
273274
#### Leiningen Socket REPL
274275

275276
For Leiningen, add the following option to your `~/.lein/profiles.clj` or your `project.clj`:
@@ -386,7 +387,6 @@ your cursor. One side effect of this is that it can mess with repl vars like
386387
`*1` and `*2`. You can disable inf-clojure's Eldoc functionality with `(setq
387388
inf-clojure-enable-eldoc nil)`.
388389

389-
390390
ElDoc should be enabled by default in Emacs 26.1+. If it is not active by
391391
default, you can activate ElDoc with `M-x eldoc-mode` or by adding the following
392392
to you Emacs config:
@@ -416,7 +416,6 @@ could alternatively use `compliment {:mvn/version "0.3.10"}`.
416416
;; or
417417
;; for compliment
418418
(inf-clojure-update-feature 'clojure 'completion "(compliment.core/completions \"%s\")")
419-
420419
```
421420

422421
If you give a form for the completion form, it is your responsibility
@@ -479,7 +478,7 @@ The explanation of this problem and solution can be found [here](https://groups.
479478
The solution is to create a file named `.jline.rc` in your `$HOME`
480479
directory and add this line to that file:
481480

482-
```
481+
```ini
483482
jline.terminal=unsupported
484483
```
485484

@@ -514,4 +513,3 @@ Distributed under the GNU General Public License; type <kbd>C-h C-c</kbd> to vie
514513
[melpa stable]: http://stable.melpa.org
515514
[Emacs init file]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Init-File.html
516515
[Clojure cli tools]: https://clojure.org/guides/getting_started
517-
[Boot]: http://boot-clj.com

0 commit comments

Comments
 (0)
close