Skip to content

Commit 5c0123f

Browse files
committed
Clarify the README quick start instructions.
- Be more clear about when the extension is expected to work without any setup, and when setting a JDK is required - Make it more clear that configuring a project JDK is optional Signed-off-by: Roland Grunberg <rgrunber@redhat.com>
1 parent 8476bef commit 5c0123f

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ Provides Java &trade; language support via
1414
Quick Start
1515
============
1616
1. Install the Extension
17-
2. If you do not have a _Java_ Development Kit correctly [set](#setting-the-jdk)
18-
* Download and install a Java Development Kit for your project (Java 1.5 or above is supported)
19-
3. Extension is activated when you first access a Java file
17+
2. On the following platforms, the extension should activate without any setup : `win32-x64`, `darwin-x64`, `darwin-arm64`, `linux-x64`, `linux-arm64`.\
18+
If on another platform, or using the "universal" version, you can [set](#setting-the-jdk) a _Java_ Development Kit. It must be Java 17 or above.
19+
3. Optionally, download and install a Java Development Kit for your project (Java 1.5 or above is supported). See [Project JDKs](#project-jdks) for more details
20+
4. Extension is activated when you first access a Java file
2021
* Recognizes projects with *Maven* or *Gradle* build files in the directory hierarchy.
2122

2223
Features
@@ -59,7 +60,7 @@ Now that Java extension will publish platform specific versions, it will embed a
5960

6061
The following part is only kept for the universal version without embedded JRE.
6162

62-
>The tooling JDK will be used to launch the Language Server for Java. And by default, will also be used to compile your projects.\
63+
>The tooling JDK will be used to launch the Language Server for Java. And by default, will also be used to compile your projects. Java 17 is the minimum required version.\
6364
\
6465
The path to the Java Development Kit can be specified by the `java.jdt.ls.java.home` setting in VS Code settings (workspace/user settings). If not specified, it is searched in the following order until a JDK meets current minimum requirement.
6566
>- the `JDK_HOME` environment variable

0 commit comments

Comments
 (0)