branch: elpa/inf-clojure
commit b2224bc4b2b93a9e4287533c9933d63742b5ebd6
Merge: 9b77479 fcf30b5
Author: Andrea Richiardi <a.richiardi.w...@gmail.com>
Commit: GitHub <nore...@github.com>
Merge pull request #145 from austinhaas/master
Explain how to create and connect to a socket REPL in README.
---
README.md | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/README.md b/README.md
index 23fa630..fa28360 100644
--- a/README.md
+++ b/README.md
@@ -103,6 +103,40 @@ 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.
+#### Starting and connecting to a socket server
+
+For Leiningen, add the following option to your ~/.lein/profiles.clj or your
project.clj:
+```
+:jvm-opts ["-Dclojure.server.repl={:port 5555 :accept
clojure.core.server/repl}"]
+```
+
+Then run `lein repl` from within your project directory to start the
+REPL, and `C-c M-c RET localhost RET 5555` from within Emacs to
+connect, or add the following to your `.dir-locals.el`
+```
+((nil . ((inf-clojure-lein-cmd . ("localhost" . 5555)))))
+```
+or the following to your `.emacs`
+```
+(setf inf-clojure-lein-cmd '("localhost" . 5555))
+```
+
+For boot, export the environment variable BOOT_JVM_OPTIONS:
+```
+export BOOT_JVM_OPTIONS='-Dclojure.server.repl="{:port 5555 :accept
clojure.core.server/repl}"'
+```
+or add the following to your `.dir-locals.el`:
+```
+((nil . ((inf-clojure-boot-cmd . ("localhost" . 5555)))))
+```
+or the following to your `.emacs`
+```
+(setf inf-clojure-boot-cmd '("localhost" . 5555))
+```
+
+You can also start a socket server via the [Clojure CLI
tools](https://clojure.org/guides/getting_started).
+Configuration options are described
[here](https://dev.clojure.org/display/design/Socket+Server+REPL).
+
#### Caveats
Note that if you decide _NOT_ to use the socket repl, it is highly recommended
