Skip to content

Commit 7a5b32f

Browse files
committed
Extend a bit the README
1 parent 1e93db8 commit 7a5b32f

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,27 @@ Clojure(Script) development:
2626
* Macroexpansion
2727
* Require `:reload`/`:reload-all`
2828
* Support connecting to socket REPLs
29-
* Support for [Lumo](https://github.com/anmonteiro/lumo)
30-
* Support for [Planck](http://planck-repl.org/)
31-
* Support for [Joker](https://joker-lang.org/)
29+
30+
In addition to the standard Clojure and ClojureScript REPLs, `inf-clojure` supports also:
31+
32+
* [Lumo](https://github.com/anmonteiro/lumo)
33+
* [Planck](http://planck-repl.org/)
34+
* [Joker](https://joker-lang.org/)
3235

3336
For a more powerful/full-featured solution see [CIDER](https://github.com/clojure-emacs/cider).
3437

38+
## Rationale
39+
40+
`inf-clojure`'s goal is to provide the simplest possible way to interact with a Clojure REPL.
41+
In Emacs terminology "inferior" process is a subprocess started by Emacs (it being the "superior" process, of course).
42+
43+
`inf-clojure` doesn't require much of setup, as at its core it simply runs a terminal REPL process, pipes input to it, and
44+
processes its output. As the Clojure socket REPL works in exactly the same manner `inf-clojure` can also interact with it.
45+
46+
Functionality like code completion and eldoc is powered by evaluation of predefined code snippets that provide the necessary results.
47+
As different Clojure REPLs have different capabilities, `inf-clojure` has to determine the type of a REPL and invoke
48+
the right code for each REPL type.
49+
3550
## Installation
3651

3752
Available on all major `package.el` community maintained repos -

0 commit comments

Comments
 (0)