Skip to content

Commit fe22ce2

Browse files
committed
Add a couple of disclaimers and a basic TOC
1 parent f63c609 commit fe22ce2

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,23 @@ It's based on ideas from the popular `inferior-lisp` package.
1212
(`inf-clojure-minor-mode`), which extends `clojure-mode` with commands
1313
to evaluate forms directly in the REPL.
1414

15+
**This documentation tracks the `master` branch of `inf-clojure`. Some of
16+
the features and settings discussed here might not be available in
17+
older releases (including the current stable release). Please, consult
18+
the relevant git tag (e.g. 2.2.0) if you need documentation for a
19+
specific `inf-clojure` release.**
20+
***
21+
22+
- [Overview](#overview)
23+
- [Rationale](#rationale)
24+
- [Installation](#installation)
25+
- [Basic Usage](#basic-usage)
26+
- [Configuration](#configuration)
27+
- [Troubleshooting](#troubleshooting)
28+
- [License](#license)
29+
30+
## Overview
31+
1532
`inf-clojure` aims to expose the extensive self-documenting features of Clojure
1633
REPLs via an Emacs package. `inf-clojure` is extremely simple and does not require special tooling.
1734
It supports the following REPLs:
@@ -117,7 +134,9 @@ point. You can, however, change this behaviour by invoking such
117134
commands with a prefix argument. For instance: `C-u C-c C-v` will ask
118135
for the symbol you want to show the docstring for.
119136

120-
## Configuration options
137+
## Configuration
138+
139+
**Note:** The configuration options were changed massively in `inf-clojure` 3.0.
121140

122141
In the time-honoured Emacs tradition `inf-clojure`'s behaviour is extremely
123142
configurable.

0 commit comments

Comments
 (0)