Skip to content

Commit e60ff79

Browse files
committed
minor docs edits
1 parent 1030053 commit e60ff79

File tree

1 file changed

+12
-31
lines changed

1 file changed

+12
-31
lines changed

README.md

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -48,39 +48,20 @@ Currently, the kernel supports
4848

4949
### Requirements
5050

51-
1. [Java JDK >= 11](https://adoptium.net/temurin/releases/). **Not the JRE**.
52-
53-
1. Ensure that the `java` command is in the PATH and is using version 11. For example:
54-
```bash
55-
> java -version
56-
openjdk version "11.0.21" 2023-10-17
57-
OpenJDK Runtime Environment Temurin-11.0.21+9 (build 11.0.21+9)
58-
OpenJDK 64-Bit Server VM Temurin-11.0.21+9 (build 11.0.21+9, mixed mode)
59-
```
60-
61-
2. Next ensure that `java` is in a location where the jdk was installed and not just the jre. Use the `java --list-modules` command to do this. The list should contain `jdk.jshell`.
62-
63-
* On *nix `java --list-modules | grep "jdk.jshell"`
64-
* On windows `java --list-modules | findstr "jdk.jshell"`
65-
66-
Both should output `jdk.jshell@` followed by your java version.
67-
68-
If the kernel cannot start with an error along the lines of
69-
```text
70-
Exception in thread "main" java.lang.NoClassDefFoundError: jdk/jshell/JShellException
71-
...
72-
Caused by: java.lang.ClassNotFoundException: jdk.jshell.JShellException
73-
...
74-
```
75-
then double check that `java` is referring to the command for the `jdk` and not the `jre`.
76-
77-
2. Some jupyter-like environment to use the kernel in.
51+
1. Java JDK >= 11
52+
Ensure that the `java` command is in the PATH and is using version 11 or newer. For example:
53+
```bash
54+
> java -version
55+
openjdk version "11.0.21" 2023-10-17
56+
OpenJDK Runtime Environment Temurin-11.0.21+9 (build 11.0.21+9)
57+
OpenJDK 64-Bit Server VM Temurin-11.0.21+9 (build 11.0.21+9, mixed mode)
58+
```
7859

79-
A non-exhaustive list of options:
60+
2. A jupyter-like environment to use the kernel in. A non-exhaustive list of options:
8061

81-
* [Jupyter](http://jupyter.org/install)
82-
* [JupyterLab](http://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html)
83-
* [nteract](https://nteract.io/desktop)
62+
* [Jupyter](http://jupyter.org/install)
63+
* [JupyterLab](http://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html)
64+
* [nteract](https://nteract.io/desktop)
8465

8566
### Installing
8667

0 commit comments

Comments
 (0)