Skip to content

Commit 4dc2b36

Browse files
committed
Use real callouts
1 parent 53efc1a commit 4dc2b36

File tree

1 file changed

+42
-28
lines changed

1 file changed

+42
-28
lines changed

README.md

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,13 @@ It's based on ideas from the popular `inferior-lisp` package.
1414
interaction minor mode (`inf-clojure-minor-mode`), which extends `clojure-mode`
1515
with commands to evaluate forms directly in the REPL.
1616

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.
2524
2625
## Overview
2726

@@ -54,21 +53,31 @@ For a more powerful/full-featured solution see [CIDER][].
5453

5554
## Rationale
5655

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).
5959

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.
6264

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.
6669

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).
70+
`inf-clojure` is built on top of Emacs's
71+
[comint](https://github.com/emacs-mirror/emacs/blob/master/lisp/comint.el). Unfortunately
72+
`comint` is pretty light on official documentation, but there is a good
73+
overview/tutorial
74+
[here](https://www.masteringemacs.org/article/comint-writing-command-interpreter).
6875

6976
## Installation
7077

71-
**Note:** `inf-clojure` requires Emacs 27 or newer.
78+
> [!IMPORTANT]
79+
>
80+
> `inf-clojure` requires Emacs 27 or newer.
7281
7382
`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
7483
[MELPA Stable][] and [MELPA][] repos.
@@ -98,7 +107,8 @@ If the installation doesn't work try refreshing the package list:
98107
`nil`.
99108

100109
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
111+
there's an `inf-clojure` REPL running:
102112

103113
```emacs-lisp
104114
(add-hook 'clojure-mode-hook #'inf-clojure-minor-mode)
@@ -108,9 +118,11 @@ You can also add the following to your Emacs config to enable
108118
(add-hook 'clojure-ts-mode-hook #'inf-clojure-minor-mode)
109119
```
110120

111-
**Warning:** Don't enable `inf-clojure-minor-mode` and `cider-mode` at the same time. They
112-
have overlapping functionality and keybindings and the result will be nothing
113-
short of havoc.
121+
> [!WARNING]
122+
>
123+
> Don't enable `inf-clojure-minor-mode` and `cider-mode` at the same time. They
124+
> have overlapping functionality and keybindings and the result will be nothing
125+
> short of havoc.
114126
115127
## Basic Usage
116128

@@ -147,8 +159,6 @@ for the symbol you want to show the docstring for.
147159

148160
## Configuration
149161

150-
**Note:** The configuration options were changed massively in `inf-clojure` 3.0.
151-
152162
In the time-honoured Emacs tradition `inf-clojure`'s behaviour is extremely
153163
configurable.
154164

@@ -173,8 +183,10 @@ that goes with it. This is most easily achieved with the following `.dir-locals.
173183
(inf-clojure-custom-repl-type . clojure)))
174184
```
175185

176-
**Note:** This file has to be in the directory in which you're invoking `inf-clojure` or a parent
177-
directory.
186+
> [!IMPORTANT]
187+
>
188+
> This file has to be in the directory in which you're invoking
189+
> `inf-clojure` or a parent directory.
178190
179191
There are two important configuration variables here:
180192

@@ -298,9 +310,11 @@ process with another `inf-clojure`. It will be in a new buffer,
298310
named `*inf-clojure*`. You can switch between the different process
299311
buffers with `switch-to-buffer`.
300312

301-
**Note:** If you're starting `inf-clojure` within a Clojure project directory
302-
the name of the project will be incorporated into the name of the REPL buffer
303-
- e.g. `*inf-clojure my-project*`.
313+
> [!NOTE]
314+
>
315+
> If you're starting `inf-clojure` within a Clojure project directory
316+
> the name of the project will be incorporated into the name of the REPL buffer
317+
> - e.g. `*inf-clojure my-project*`.
304318
305319
Commands that send text from source buffers to Clojure processes (like `inf-clojure-eval-defun`
306320
or `inf-clojure-show-arglists`) have to choose a process to send to, when you have more than

0 commit comments

Comments
 (0)