branch: elpa/inf-clojure
commit 58150d702a46f65386775cbf37f0962ce7581da4
Author: Bozhidar Batsov <bozhi...@batsov.com>
Commit: Bozhidar Batsov <bozhi...@batsov.com>
Improve some wording in the README
---
README.md | 43 +++++++++++++++++++++++--------------------
1 file changed, 23 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
index d1ddc19..8f05c00 100644
--- a/README.md
+++ b/README.md
@@ -136,10 +136,23 @@ for the symbol you want to show the docstring for.
## Configuration
-## Most Common 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.
+
+You can set custom values to `inf-clojure` variables on a
+per-project basis using [directory
+variables](https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html)
+or by setting them in in your init file.
+
+You can see all the configuration options available using the command
+`M-x customize-group RET inf-clojure`.
+
+### Startup
Most likely you will want to set the startup command and the repl
-type. This is most easily set with the follow dir-locals
+type. This is most easily set with the following `dir-locals.el`:
```emacs-lisp
((nil
@@ -147,28 +160,18 @@ type. This is most easily set with the follow dir-locals
(inf-clojure-custom-repl-type . clojure)))
```
-There are two important commands here:
-1. `inf-clojure-custom-startup`: Which startup command to use so
- inf-clojure can run the inferior process and
-2. `inf-clojure-custom-repl-type`: Which repl type it is so
- inf-clojure knows how to format commands to the repl
+**Note:** This file has to be in the directory in which you're invoking
`inf-clojure`.
-If these are set and you wish to prevent inf-clojure from using them,
-use a prefix arg when invoking `inf-clojure`.
-
-### All Configuration
-**Note:** The configuration options were changed massively in `inf-clojure`
3.0.
+There are two important configuration variables here:
-In the time-honoured Emacs tradition `inf-clojure`'s behaviour is extremely
-configurable.
+1. `inf-clojure-custom-startup`: Which startup command to use so
+ inf-clojure can run the inferior Clojure process (REPL).
+2. `inf-clojure-custom-repl-type`: The type of the REPL started by the above
command (e.g. `lumo`).
-You can set custom values to `inf-clojure` variables on a
-per-project basis using [directory
-variables](https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html)
-or by setting them in in your init file.
+If these are set and you wish to prevent inf-clojure from using them,
+use a prefix arg when invoking `inf-clojure` (`C-u M-x inf-clojure`).
-You can see all the configuration options available using the command
-`M-x customize-group RET inf-clojure`.
+### REPL Features
The supported REPL-features are in an alist called
`inc-clojure-repl-features` and it has the following shape:
