Skip to content

Commit e95d2af

Browse files
[docs] Scrub Getting Started section (#3771)
1 parent c0e7f25 commit e95d2af

File tree

5 files changed

+77
-246
lines changed

5 files changed

+77
-246
lines changed

doc/modules/ROOT/pages/about/compatibility.adoc

Lines changed: 8 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,17 @@ NOTE: We pay special attention to supporting whatever nREPL is bundled with the
1616

1717
== Java
1818

19-
CIDER officially targets Java 8, Java 11, Java 17, Java 21 and the most recent rapid
20-
release version (e.g. Java 22). Generally speaking, we aim
21-
to support all Java releases that are currently officially supported
22-
by Oracle.footnote:[You can find more information about the supported Java releases https://www.oracle.com/java/technologies/java-se-support-roadmap.html[here].]
19+
CIDER officially targets Java 8, Java 11, Java 17, Java 21, and the most recent
20+
non-LTS version. Generally speaking, we aim to support all Java releases that
21+
are currently officially supported by Oracle.footnote:[You can find more
22+
information about the supported Java releases
23+
https://www.oracle.com/java/technologies/java-se-support-roadmap.html[here].]
2324

2425
NOTE: The requirements for Java are pretty much ``cider-nrepl``'s requirements.
2526

26-
On Linux you are also required to make sure that JDK sources and javadocs are installed.
27-
You can find example commands in xref:troubleshooting.adoc#navigation-to-jdk-sources-doesnt-work[Troubleshooting].
27+
While CIDER can work with
28+
https://www.ibm.com/think/topics/jvm-vs-jre-vs-jdk[JRE], it is recommended to
29+
use the full JDK distribution.
2830

2931
== Clojure
3032

@@ -46,149 +48,33 @@ Currently we apply the same policy for Clojure and ClojureScript support.
4648

4749
== Compatibility Matrix
4850

49-
NOTE: For a very long time CIDER and cider-nrepl were released in lock-step, but
50-
this changed in CIDER 0.18. The actual releases diverged for the first time in
51-
CIDER 0.23.
52-
5351
Below you can find the official compatibility matrix for CIDER.
5452

5553
.Compatibility Matrix
5654
|===
5755
| CIDER | Emacs | nREPL | cider-nrepl | Required JDK | Required Clojure
5856

59-
| 0.22
60-
| 25.1
61-
| 0.6
62-
| 0.22
63-
| 8
64-
| 1.8
65-
66-
| 0.23
67-
| 25.1
68-
| 0.6
69-
| 0.22
70-
| 8
71-
| 1.8
72-
73-
| 0.24
74-
| 25.1
75-
| 0.6
76-
| 0.24
77-
| 8
78-
| 1.8
79-
80-
| 0.25
81-
| 25.1
82-
| 0.6
83-
| 0.25
84-
| 8
85-
| 1.8
86-
87-
| 0.26
88-
| 25.1
89-
| 0.6
90-
| 0.25
91-
| 8
92-
| 1.8
93-
94-
| 1.0
95-
| 25.1
96-
| 0.6
97-
| 0.25
98-
| 8
99-
| 1.8
100-
10157
| 1.1
10258
| 25.1
10359
| 0.6
10460
| 0.25
10561
| 8
10662
| 1.8
10763

108-
| 1.2
109-
| 26.1
110-
| 0.9
111-
| 0.27
112-
| 8
113-
| 1.8
114-
115-
| 1.3
116-
| 26.1
117-
| 0.9
118-
| 0.28
119-
| 8
120-
| 1.8
121-
122-
| 1.4
123-
| 26.1
124-
| 0.9
125-
| 0.28
126-
| 8
127-
| 1.8
128-
129-
| 1.5
130-
| 26.1
131-
| 0.9
132-
| 0.28
133-
| 8
134-
| 1.8
135-
136-
| 1.6
137-
| 26.1
138-
| 1.0
139-
| 0.29
140-
| 8
141-
| 1.8
142-
143-
| 1.7
144-
| 26.1
145-
| 1.0
146-
| 0.30
147-
| 8
148-
| 1.8
149-
150-
| 1.8
151-
| 26.1
152-
| 1.0
153-
| 0.40
154-
| 8
155-
| 1.8
156-
15764
| 1.9
15865
| 26.1
15966
| 1.0
16067
| 0.41
16168
| 8
16269
| 1.8
16370

164-
| 1.12
165-
| 26.1
166-
| 1.0
167-
| 0.44
168-
| 8
169-
| 1.9
170-
17171
| 1.13
17272
| 26.1
17373
| 1.0
17474
| 0.44
17575
| 8
17676
| 1.9
17777

178-
| 1.14
179-
| 26.1
180-
| 1.0
181-
| 0.47
182-
| 8
183-
| 1.10
184-
185-
| 1.15
186-
| 26.1
187-
| 1.0
188-
| 0.49
189-
| 8
190-
| 1.10
191-
19278
| 1.16
19379
| 26.1
19480
| 1.0

doc/modules/ROOT/pages/basics/installation.adoc

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,14 @@ release. If you're new to Emacs you might want to go through
1212
https://www.gnu.org/software/emacs/tour/index.html[the guided tour of Emacs]
1313
and the built-in tutorial (just press kbd:[C-h t]).
1414

15-
CIDER officially supports Emacs 26.1+, Java 8+ and Clojure(Script)
16-
1.8+. CIDER 0.17 (Andalucía) was the final release which supported
17-
Java 7 and Clojure(Script) 1.7.
15+
CIDER officially supports Emacs 26.1+, Java 8+, and Clojure(Script) 1.10+. If
16+
you need to work with earlier versions, check
17+
xref:about/compatibility.adoc#compatibility-matrix[compatibility matrix].
1818

1919
You'll also need a recent version of either the Clojure CLI tools or your
2020
favorite build tool (Leiningen, Boot, or Gradle) to be able to start CIDER via
2121
`cider-jack-in`. Generally it's a good idea to use the latest stable versions.
2222

23-
On Linux you are also required to make sure that JDK sources and javadocs are installed.
24-
You can find example commands in xref:troubleshooting.adoc#navigation-to-jdk-sources-doesnt-work[Troubleshooting].
25-
2623
== Installation via package.el
2724

2825
CIDER is available on all major `package.el` community

doc/modules/ROOT/pages/basics/middleware_setup.adoc

Lines changed: 15 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,19 @@
44
NOTE: You can skip this section if you don't plan to use `cider-connect` or don't care
55
about the advanced functionality that requires `cider-nrepl`.
66

7-
Much of CIDER's functionality depends on its own https://github.com/clojure-emacs/cider-nrepl[nREPL
8-
middleware]. Starting
9-
with version 0.11, `cider-jack-in` (kbd:[C-c C-x (C-)j (C-)j])
10-
automatically injects this middleware and other dependencies as required.
11-
12-
NOTE: In the past, if you were setting up CIDER, you might have had to
13-
modify `profiles.clj` or `profile.boot`. CIDER now handles
14-
everything automatically and you don't need to add anything
15-
special to these files. The same is true of your `deps.edn` file and
16-
your `build.gradle` (as of Clojurephant 0.7.0-alpha.6).
17-
18-
If you prefer a standalone REPL, you will need to invoke
19-
`cider-connect` instead of `cider-jack-in` and manually add the
20-
dependencies to your Clojure project (explained in the following
21-
sections).
7+
Much of CIDER's functionality depends on its own
8+
https://github.com/clojure-emacs/cider-nrepl[nREPL middleware]. `cider-jack-in`
9+
(kbd:[C-c C-x (C-)j (C-)j]) automatically injects this middleware and other
10+
dependencies as required. But if you prefer a standalone REPL, you will need to
11+
invoke `cider-connect` instead of `cider-jack-in` and manually add the
12+
dependencies to your Clojure project (explained in the following sections).
2213

2314
== Setting Up a Standalone REPL
2415

2516
=== Using Leiningen
2617

27-
NOTE: Make sure you're using Leiningen 2.9.0 or newer, as 2.9.0 is the first
28-
release to ship with nREPL 0.6.
29-
3018
Use the convenient plugin for defaults, either in your project's
31-
`project.clj` file or in the :repl profile in `~/.lein/profiles.clj`.
19+
`project.clj` file or in the `:repl` profile in `~/.lein/profiles.clj`.
3220

3321
[source,clojure]
3422
----
@@ -46,27 +34,6 @@ WARNING: Be careful not to place this in the `:user` profile, as this way CIDER'
4634
middleware will always get loaded, causing `lein` to start slower. You really
4735
need it just for `lein repl` and this is what the `:repl` profile is for.
4836

49-
=== Using Boot
50-
51-
NOTE: Make sure you're using Boot 2.8.3 or newer, as 2.8.3 is the first
52-
release to ship with nREPL 0.6.
53-
54-
Boot users can configure the tool to include the middleware automatically in
55-
all of their projects using a `~/.boot/profile.boot` file like so:
56-
57-
[source,clojure]
58-
----
59-
(require 'boot.repl)
60-
61-
(swap! boot.repl/*default-dependencies*
62-
concat '[[cider/cider-nrepl "0.52.0"]])
63-
64-
(swap! boot.repl/*default-middleware*
65-
conj 'cider.nrepl/cider-middleware)
66-
----
67-
68-
For more information visit https://github.com/boot-clj/boot/wiki/Cider-REPL[boot-clj wiki].
69-
7037
=== Using tools.deps
7138

7239
You can add the following aliases to your deps.edn in order to launch
@@ -81,7 +48,7 @@ run `cider-connect` or `cider-connect-cljs`.
8148
8249
:cider-cljs {:extra-deps {org.clojure/clojurescript {:mvn/version "1.10.339"}
8350
cider/cider-nrepl {:mvn/version "0.52.0"}
84-
cider/piggieback {:mvn/version "0.5.3"}}
51+
cider/piggieback {:mvn/version "0.6.0"}}
8552
:main-opts ["-m" "nrepl.cmdline" "--middleware"
8653
"[cider.nrepl/cider-middleware,cider.piggieback/wrap-cljs-repl]"]}
8754
----
@@ -133,11 +100,10 @@ server with CIDER's own nREPL handler.
133100

134101
It goes without saying that your project should depend on `cider-nrepl`.
135102

136-
NOTE: Prior to CIDER 0.18, CIDER and cider-nrepl were always released together
137-
and their versions had to match for things to work (e.g. CIDER 0.15 required
138-
cider-nrepl 0.15). But as the prominence of cider-nrepl grew and many other
139-
tools started using it, the two projects evolved separately and are no longer in
140-
tight lock-step. Usually, any recent version of cider-nrepl should be (mostly)
141-
compatible with a recent version of CIDER. You can check the required version of
142-
cider-nrepl for your version of CIDER by looking at
143-
`cider-required-middleware-version`.
103+
NOTE: CIDER and cider-nrepl projects are co-developed, but are not released in a
104+
lock-step — they have differing versions. Usually, any recent version of
105+
cider-nrepl should be (mostly) compatible with a recent version of CIDER. You
106+
can check the required version of cider-nrepl for your version of CIDER by
107+
looking at `cider-required-middleware-version`. See also the
108+
xref:about/compatibility.adoc#compatibility-matrix[compatibility
109+
matrix].

0 commit comments

Comments
 (0)