You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-28Lines changed: 42 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,14 +14,13 @@ It's based on ideas from the popular `inferior-lisp` package.
14
14
interaction minor mode (`inf-clojure-minor-mode`), which extends `clojure-mode`
15
15
with commands to evaluate forms directly in the REPL.
16
16
17
-
-----------
18
-
19
-
**This documentation tracks the `master` branch of `inf-clojure`. Some of
20
-
the features and settings discussed here might not be available in
21
-
older releases (including the current stable release). Please, consult
22
-
the relevant git tag (e.g. 2.2.0) if you need documentation for a
23
-
specific `inf-clojure` release.**
24
-
***
17
+
> [!IMPORTANT]
18
+
>
19
+
> This documentation tracks the `master` branch of `inf-clojure`. Some of
20
+
> the features and settings discussed here might not be available in
21
+
> older releases (including the current stable release). Please, consult
22
+
> the relevant git tag (e.g. 2.2.0) if you need documentation for a
23
+
> specific `inf-clojure` release.
25
24
26
25
## Overview
27
26
@@ -54,21 +53,31 @@ For a more powerful/full-featured solution see [CIDER][].
54
53
55
54
## Rationale
56
55
57
-
`inf-clojure`'s goal is to provide the simplest possible way to interact with a Clojure REPL.
58
-
In Emacs terminology "inferior" process is a subprocess started by Emacs (it being the "superior" process, of course).
56
+
`inf-clojure`'s goal is to provide the simplest possible way to interact with a
57
+
Clojure REPL. In Emacs terminology "inferior" process is a subprocess started
58
+
by Emacs (it being the "superior" process, of course).
59
59
60
-
`inf-clojure` doesn't require much of setup, as at its core it simply runs a terminal REPL process, pipes input to it, and
61
-
processes its output. As the Clojure socket REPL works in exactly the same manner `inf-clojure` can also interact with it.
60
+
`inf-clojure` doesn't require much of setup, as at its core it simply runs a
61
+
terminal REPL process, pipes input to it, and processes its output. As the
62
+
Clojure socket REPL works in exactly the same manner `inf-clojure` can also
63
+
interact with it.
62
64
63
-
Functionality like code completion and eldoc is powered by evaluation of predefined code snippets that provide the necessary results.
64
-
As different Clojure REPLs have different capabilities, `inf-clojure` tracks the type of a REPL and invokes
65
-
the right code for each REPL type.
65
+
Functionality like code completion and eldoc is powered by evaluation of
66
+
predefined code snippets that provide the necessary results. As different
67
+
Clojure REPLs have different capabilities, `inf-clojure` tracks the type of a
68
+
REPL and invokes the right code for each REPL type.
66
69
67
-
`inf-clojure` is built on top of Emacs's [comint](https://github.com/emacs-mirror/emacs/blob/master/lisp/comint.el). Unfortunately `comint` is pretty light on official documentation, but there is a good overview/tutorial [here](https://www.masteringemacs.org/article/comint-writing-command-interpreter).
**Note:**`inf-clojure` requires Emacs 27 or newer.
78
+
> [!IMPORTANT]
79
+
>
80
+
> `inf-clojure` requires Emacs 27 or newer.
72
81
73
82
`inf-clojure` is available on the official [NonGNU ELPA](https://elpa.nongnu.org/nongnu/inf-clojure.html)`package.el` repo and on the community-maintained
74
83
[MELPA Stable][] and [MELPA][] repos.
@@ -98,7 +107,8 @@ If the installation doesn't work try refreshing the package list:
98
107
`nil`.
99
108
100
109
You can also add the following to your Emacs config to enable
101
-
`inf-clojure-minor-mode` for Clojure source buffers, regardless of whether there's an `inf-clojure` REPL running:
110
+
`inf-clojure-minor-mode` for Clojure source buffers, regardless of whether
0 commit comments