summaryrefslogtreecommitdiff
path: root/doc/installation.md
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2018-09-08 10:27:30 -0700
committerSean Whitton <spwhitton@spwhitton.name>2018-09-08 10:27:30 -0700
commit9148631b2f93ae849cfa141ac11447be42c8f31c (patch)
tree037f9fa2cbb72d7ca0118c1f89961efbafb64065 /doc/installation.md
parent42d3b3f307a8d59632bba30a35d2695f72cf63dc (diff)
parent58f79015f3a28d6aee2fb841b31db3d8a46829d5 (diff)
Merge tag 'v0.18.0+dfsg' into wip/master
DFSG-clean upstream version 0.18.0
Diffstat (limited to 'doc/installation.md')
-rw-r--r--doc/installation.md33
1 files changed, 19 insertions, 14 deletions
diff --git a/doc/installation.md b/doc/installation.md
index 79712459..69338553 100644
--- a/doc/installation.md
+++ b/doc/installation.md
@@ -1,9 +1,10 @@
## CIDER's nREPL middleware
-Much of CIDER's functionality depends on the presence of CIDER's
-own [nREPL middleware](https://github.com/clojure-emacs/cider-nrepl). Starting
-with version 0.11, When `cider-jack-in` (<kbd>C-c M-j</kbd>) is used, CIDER
-takes care of injecting it and its other dependencies.
+Much of CIDER's functionality depends on the presence of CIDER's own
+[nREPL
+middleware](https://github.com/clojure-emacs/cider-nrepl). Starting
+with version 0.11, When `cider-jack-in` (<kbd>C-c C-x (C-)j (C-)j</kbd>) is used,
+CIDER takes care of injecting it and its other dependencies.
**`profiles.clj` or `profile.boot` don't need to be modified anymore for the above use case!**
@@ -34,12 +35,14 @@ Use the convenient plugin for defaults, either in your project's
A minimal `profiles.clj` for CIDER would be:
```clojure
-{:repl {:plugins [[cider/cider-nrepl "0.17.0"]]}}
+{:repl {:plugins [[cider/cider-nrepl "0.18.0"]]}}
```
-**Be careful not to place this in the `:user` profile, as this way CIDER's
-middleware will always get loaded, causing `lein` to start slower. You really
-need it just for `lein repl` and this is what the `:repl` profile is for.**
+!!! warning
+
+ Be careful not to place this in the `:user` profile, as this way CIDER's
+ middleware will always get loaded, causing `lein` to start slower. You really
+ need it just for `lein repl` and this is what the `:repl` profile is for.
#### Using Boot
@@ -50,7 +53,7 @@ all of their projects using a `~/.boot/profile.boot` file like so:
(require 'boot.repl)
(swap! boot.repl/*default-dependencies*
- concat '[[cider/cider-nrepl "0.17.0"]])
+ concat '[[cider/cider-nrepl "0.18.0"]])
(swap! boot.repl/*default-middleware*
conj 'cider.nrepl/cider-middleware)
@@ -65,7 +68,7 @@ server with CIDER's own nREPL handler.
```clojure
(ns my-app
- (:require [clojure.tools.nrepl.server :as nrepl-server]
+ (:require [nrepl.server :as nrepl-server]
[cider.nrepl :refer (cider-nrepl-handler)]))
(defn -main
@@ -75,8 +78,10 @@ server with CIDER's own nREPL handler.
It goes without saying that your project should depend on `cider-nrepl`.
-***
+!!! note
-`x.y.z` should match the version of CIDER you're currently using (say `0.17.0`).
-For snapshot releases of CIDER you should use the snapshot of the plugin as well
-(say `0.17.0-SNAPSHOT`).
+ `x.y.z` should be compatible with the version of CIDER you're currently using.
+ The required version can be checked in `cider-required-middleware-version`.
+ Prior to CIDER 0.18, CIDER and cider-nrepl were always released together
+ and their versions had to match for things to work, but as the prominence
+ of cider-nrepl grew and many other tools started using, this was changed.