[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/inf-clojure 58150d7 256/313: Improve some wording in the R
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/inf-clojure 58150d7 256/313: Improve some wording in the README |
Date: |
Wed, 11 Aug 2021 10:00:29 -0400 (EDT) |
branch: elpa/inf-clojure
commit 58150d702a46f65386775cbf37f0962ce7581da4
Author: Bozhidar Batsov <bozhidar@batsov.com>
Commit: Bozhidar Batsov <bozhidar@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:
- [nongnu] elpa/inf-clojure 7493ed8 166/313: Set inf-clojure-*-cmd :risky and :safe properties, (continued)
- [nongnu] elpa/inf-clojure 7493ed8 166/313: Set inf-clojure-*-cmd :risky and :safe properties, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure b048358 173/313: Add expression break chars and prevent completions for numbers (#110), ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 8c27b06 177/313: Introduce the tools.deps project type, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 5c8f590 179/313: [Fix #116] Set inf-clojure-buffer REPL type on detect, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 7b2fcd7 184/313: Revive inf-clojure-apropos, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 8baa7ad 185/313: Correct inf-clojure-apropos key binding, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure d3c0d4f 187/313: Avoid throwing an error for frequent operations like completion, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 630471b 194/313: Update CHANGELOG.md, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure c3217c3 200/313: Skip sanitation of comments, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 9b77479 207/313: Set inf-clojure-tools-deps-cmd to "clojure" (#144), ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 58150d7 256/313: Improve some wording in the README,
ELPA Syncer <=
- [nongnu] elpa/inf-clojure f63c609 252/313: Fix a typo, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure b5e915c 204/313: Travis test like in cider, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure b88de63 260/313: Tweak a docstring, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure e144b33 276/313: Improve the Makefile commands, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 917ee77 268/313: Improve the README a bit, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 91f4121 280/313: Bump the copyright years, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 8eaf885 275/313: [Fix #152] Sanitize should only remove whitespace at the end of a command, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure ec4a85e 285/313: Bump copyright years, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 2046b12 298/313: Make inf-clojure-repl-p a bit more flexible, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure e1d7007 297/313: Touch up the previous commit, ELPA Syncer, 2021/08/11