[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/inf-clojure fe22ce2 253/313: Add a couple of disclaimers a
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/inf-clojure fe22ce2 253/313: Add a couple of disclaimers and a basic TOC |
Date: |
Wed, 11 Aug 2021 10:00:28 -0400 (EDT) |
branch: elpa/inf-clojure
commit fe22ce2bd6848e9ed69e8349c518f90a79a5c101
Author: Bozhidar Batsov <bozhidar@batsov.com>
Commit: Bozhidar Batsov <bozhidar@batsov.com>
Add a couple of disclaimers and a basic TOC
---
README.md | 21 ++++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 7ad6334..83fcbe1 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,23 @@ It's based on ideas from the popular `inferior-lisp` package.
(`inf-clojure-minor-mode`), which extends `clojure-mode` with commands
to evaluate forms directly in the REPL.
+**This documentation tracks the `master` branch of `inf-clojure`. Some of
+the features and settings discussed here might not be available in
+older releases (including the current stable release). Please, consult
+the relevant git tag (e.g. 2.2.0) if you need documentation for a
+specific `inf-clojure` release.**
+***
+
+- [Overview](#overview)
+- [Rationale](#rationale)
+- [Installation](#installation)
+- [Basic Usage](#basic-usage)
+- [Configuration](#configuration)
+- [Troubleshooting](#troubleshooting)
+- [License](#license)
+
+## Overview
+
`inf-clojure` aims to expose the extensive self-documenting features of Clojure
REPLs via an Emacs package. `inf-clojure` is extremely simple and does not
require special tooling.
It supports the following REPLs:
@@ -117,7 +134,9 @@ point. You can, however, change this behaviour by invoking
such
commands with a prefix argument. For instance: `C-u C-c C-v` will ask
for the symbol you want to show the docstring for.
-## Configuration options
+## Configuration
+
+**Note:** The configuration options were changed massively in `inf-clojure`
3.0.
In the time-honoured Emacs tradition `inf-clojure`'s behaviour is extremely
configurable.
- [nongnu] elpa/inf-clojure 696e5ef 309/313: Add a link to Discord, (continued)
- [nongnu] elpa/inf-clojure 696e5ef 309/313: Add a link to Discord, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 49b2257 310/313: Remove the TOC, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure fcf30b5 210/313: README: Add instructions for including socket config in .dir-locals.el or .emacs., ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure b53074a 216/313: Tweak README and discourage terminal REPLs, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure e14dbba 145/313: Update the commentary section of the package, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 59868ff 218/313: Remove quotes from reload and fix argument parsing (#148), ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure d0d269d 226/313: Tweak the changelog, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 2445af7 235/313: Add insert commands to the changelog, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure eb5e6a2 234/313: Remove whitespace, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 2cfc38f 239/313: Move repl features into single datastructure for clarity, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure fe22ce2 253/313: Add a couple of disclaimers and a basic TOC,
ELPA Syncer <=
- [nongnu] elpa/inf-clojure e33a546 243/313: Bugfixes and readme updates, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure c9681d0 257/313: Tweak some wording, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 2c8e46b 273/313: Release 3.0, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 1ba6416 255/313: Tweak the changelog, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure d7eb9ce 267/313: Update the changelog, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 53025bf 270/313: Correct misspelled function. Fixes #181, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure aaca773 288/313: Tweak a changelog entry, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 3e712d9 292/313: Add a couple of changelog entries, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 54ac59a 295/313: Modeline with connected info, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure f7b6a8e 296/313: Don't try to select a dead buffer, ELPA Syncer, 2021/08/11