[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/inf-clojure 7a5b32f 238/313: Extend a bit the README
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/inf-clojure 7a5b32f 238/313: Extend a bit the README |
Date: |
Wed, 11 Aug 2021 10:00:25 -0400 (EDT) |
branch: elpa/inf-clojure
commit 7a5b32ff8cc24955112b7baabdf8e845c518e26c
Author: Bozhidar Batsov <bozhidar@batsov.com>
Commit: Bozhidar Batsov <bozhidar@batsov.com>
Extend a bit the README
---
README.md | 21 ++++++++++++++++++---
1 file changed, 18 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 53d68b1..5be7426 100644
--- a/README.md
+++ b/README.md
@@ -26,12 +26,27 @@ Clojure(Script) development:
* Macroexpansion
* Require `:reload`/`:reload-all`
* Support connecting to socket REPLs
-* Support for [Lumo](https://github.com/anmonteiro/lumo)
-* Support for [Planck](http://planck-repl.org/)
-* Support for [Joker](https://joker-lang.org/)
+
+In addition to the standard Clojure and ClojureScript REPLs, `inf-clojure`
supports also:
+
+* [Lumo](https://github.com/anmonteiro/lumo)
+* [Planck](http://planck-repl.org/)
+* [Joker](https://joker-lang.org/)
For a more powerful/full-featured solution see
[CIDER](https://github.com/clojure-emacs/cider).
+## Rationale
+
+`inf-clojure`'s goal is to provide the simplest possible way to interact with
a Clojure REPL.
+In Emacs terminology "inferior" process is a subprocess started by Emacs (it
being the "superior" process, of course).
+
+`inf-clojure` doesn't require much of setup, as at its core it simply runs a
terminal REPL process, pipes input to it, and
+processes its output. As the Clojure socket REPL works in exactly the same
manner `inf-clojure` can also interact with it.
+
+Functionality like code completion and eldoc is powered by evaluation of
predefined code snippets that provide the necessary results.
+As different Clojure REPLs have different capabilities, `inf-clojure` has to
determine the type of a REPL and invoke
+the right code for each REPL type.
+
## Installation
Available on all major `package.el` community maintained repos -
- [nongnu] elpa/inf-clojure c23c55e 312/313: Release 3.1.0, (continued)
- [nongnu] elpa/inf-clojure c23c55e 312/313: Release 3.1.0, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 8c37fba 139/313: Mention some of the essential features in the README, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure f420c8a 199/313: Add sanitation to inf-clojure-send-string, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure e68108d 213/313: Make three sections for the socket REPLs, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 1295e58 214/313: [security] Don't execute arbitrary functions (#146), ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 6913798 217/313: Fix small things in README again, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure f3d6a68 223/313: Add support for joker (#160), ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 98db4c8 227/313: Bump the copyright years, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure b29a3f1 221/313: Use CircleCI for CI testing (#159), ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 0697d6f 233/313: Add insert last sexp and keymap to hold them all, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 7a5b32f 238/313: Extend a bit the README,
ELPA Syncer <=
- [nongnu] elpa/inf-clojure 30638a0 242/313: Remove old defcustomed, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 1bac8fe 249/313: Tweak some messages, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure f1c8323 261/313: Fix some wording, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 23492b5 263/313: Trim some whitespace, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 8be9cec 269/313: Use kbd-style keybindings everywhere, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 68ab0f7 282/313: Bump the required Emacs version, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 81e0912 287/313: Tweak some features, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 675e9be 290/313: Handle newlines between forms for `inf-clojure-eval-buffer`, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure b601d48 266/313: Tweak the README a bit, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 91145b0 293/313: Function to select repls as the current active connection, ELPA Syncer, 2021/08/11