Skip to content

Commit 0fbcfcb

Browse files
committed
Improve the README a bit
1 parent 8c37fba commit 0fbcfcb

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

README.md

+23-12
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,9 @@ result will be nothing short of havoc.**
6767

6868
## Usage
6969

70-
`M-x inf-clojure` or `C-c C-z` within a Clojure source file.
70+
Just invoke `M-x inf-clojure` or press `C-c C-z` within a Clojure source file.
71+
This will start a REPL process for the current project and you can start
72+
interacting with it.
7173

7274
`inf-clojure` has several custom variables which control the command
7375
used to start a REPL for particular project type - `inf-clojure-lein-cmd`,
@@ -82,25 +84,31 @@ command line with `planck -n 5555`.
8284
Use `C-u C-c C-z` to start a REPL with a different command/cons pair than
8385
the default specified in `inf-clojure-program`.
8486

87+
You can use `M-x inf-clojure-connect` to connect to a running socket-repl.
88+
You will be prompted for host and port.
89+
8590
You can set custom values to `inf-clojure` variables on a per-project basis using [directory
8691
variables](https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html).
8792

88-
The REPL commands don't prompt by default but a prefix argument will invert
89-
this. For instance: `C-u C-c C-v` will ask for the symbol you want to show the
90-
docstring for.
91-
92-
You can use `M-x inf-clojure-connect` to connect to a running socket-repl.
93-
You will be prompted for host and port.
93+
Many `inf-clojure-minor-mode` commands by default act on the symbol at
94+
point. You can, however, change this behaviour by invoking such
95+
commands with a prefix argument. For instance: `C-u C-c C-v` will ask
96+
for the symbol you want to show the docstring for.
9497

9598
## REPL Type
9699

97-
An `inf-clojure` REPL can be of different types: Clojure, ClojureScript, Lumo and Planck are all potentially valid options.
98-
At the moment, the default Clojure REPL, the Lumo REPL (though partially, see https://github.com/clojure-emacs/inf-clojure/pull/44), and the Planck REPL are supported.
100+
An `inf-clojure` REPL can be of different types: Clojure,
101+
ClojureScript, Lumo and Planck are all potentially valid options. At
102+
the moment, the default Clojure REPL, the Lumo REPL (though partially,
103+
see https://github.com/clojure-emacs/inf-clojure/pull/44), and the
104+
Planck REPL are supported.
99105

100106
To hook up a custom REPL type, just use the right launch command (or connect through socket).
101107
For example, for Lumo just add the following in your `.dir-locals.el`:
102108

103-
((nil . ((inf-clojure-boot-cmd . "lumo -d")))) ;; inf-clojure-lein-cmd if you are using Leiningen
109+
```el
110+
((nil . ((inf-clojure-boot-cmd . "lumo -d")))) ;; inf-clojure-lein-cmd if you are using Leiningen
111+
```
104112

105113
## ElDoc
106114

@@ -124,9 +132,12 @@ You can leave it enabled, it just won't show anything in the echo area.
124132

125133
## Lumo Setup
126134

127-
For an optimal Lumo experience the `-d` needs to be passed to Lumo when launched from the command line. This disable `readline` support in order to play nicely with emacs.
135+
For an optimal Lumo experience the `-d` needs to be passed to Lumo
136+
when launched from the command line. This disable `readline` support
137+
in order to play nicely with emacs.
128138

129-
For example, you can use the following command (assuming `cp` contains the classpath) in your `.dir-locals.el`:
139+
For example, you can use the following command (assuming `cp` contains
140+
the classpath) in your `.dir-locals.el`:
130141

131142
```el
132143
((nil . (eval . (setq inf-clojure-boot-cmd (concat "lumo -d -c "

0 commit comments

Comments
 (0)