From 2f7a2babb42d359d3a8e39ba54d4476e9a83a1c3 Mon Sep 17 00:00:00 2001 From: Dan Newton Date: Mon, 15 Apr 2019 11:30:47 +0100 Subject: [PATCH] CORDA-2602 - Update getting setup guide java details (#5019) Remove some information that is way to specific for installing the oracle jdk. Add mention of zulu openjdk to the docs. Specify that the docs will go through how to install the oracle jdk only but provide links to amazon corretto, openjdk and zulu. Also say that we support intellij 2019 which has been released now. --- docs/source/getting-set-up.rst | 56 ++++++++++++++++++++++------------ 1 file changed, 37 insertions(+), 19 deletions(-) diff --git a/docs/source/getting-set-up.rst b/docs/source/getting-set-up.rst index 7e727046fb..62afd07b70 100644 --- a/docs/source/getting-set-up.rst +++ b/docs/source/getting-set-up.rst @@ -6,10 +6,22 @@ Software requirements Corda uses industry-standard tools: -* **Java 8 JVM** - we require at least version **|java_version|**, but do not currently support Java 9 or higher. - We have tested with Oracle JDK, Amazon Corretto, and Red Hat's OpenJDK builds. Please note that OpenJDK builds - usually exclude JavaFX, which our GUI tools require. -* **IntelliJ IDEA** - supported versions **2017.x** and **2018.x** (with Kotlin plugin version |kotlin_version|) +* **Java 8 JVM** - we require at least version |java_version|, but do not currently support Java 9 or higher. + + We have tested with the following builds: + + * `Oracle JDK `_ + + * `Amazon Corretto `_ + + * `Red Hat's OpenJDK `_ + + * `Zulu's OpenJDK `_ + + Please note that OpenJDK builds usually exclude JavaFX, which our GUI tools require. + +* **IntelliJ IDEA** - supported versions **2017.x**, **2018.x** and **2019.x** (with Kotlin plugin version |kotlin_version|) + * **Gradle** - we use 4.10 and the ``gradlew`` script in the project / samples directories will download it for you. Please note: @@ -46,6 +58,16 @@ The set-up instructions are available for the following platforms: .. _windows-label: +.. note:: These setup instructions will guide you on how to install the Oracle JDK. Each JDK can be found on their respective sites: + + * `Oracle `_ + + * `Amazon Corretto `_ + + * `Red Hat OpenJDK `_ + + * `Zulu OpenJDK `_ + Windows ------- @@ -54,12 +76,10 @@ Windows Java ^^^^ 1. Visit http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html -2. Scroll down to "Java SE Development Kit 8uXXX" (where "XXX" is the latest minor version number) -3. Toggle "Accept License Agreement" -4. Click the download link for jdk-8uXXX-windows-x64.exe (where "XXX" is the latest minor version number) -5. Download and run the executable to install Java (use the default settings) -6. Add Java to the PATH environment variable by following the instructions at https://docs.oracle.com/javase/7/docs/webnotes/install/windows/jdk-installation-windows.html#path -7. Open a new command prompt and run ``java -version`` to test that Java is installed correctly +2. Click the download link for jdk-8uXXX-windows-x64.exe (where "XXX" is the latest minor version number) +3. Download and run the executable to install Java (use the default settings) +4. Add Java to the PATH environment variable by following the instructions in the `Oracle documentation `_ +5. Open a new command prompt and run ``java -version`` to test that Java is installed correctly Git ^^^ @@ -72,7 +92,7 @@ IntelliJ ^^^^^^^^ 1. Visit https://www.jetbrains.com/idea/download/download-thanks.html?code=IIC 2. Download and run the executable to install IntelliJ Community Edition (use the default settings) -3. Ensure the Kotlin plugin in Intellij is updated to version |kotlin_version| +3. Ensure the Kotlin plugin in Intellij is updated to version |kotlin_version| (new installs will contains this version) .. _mac-label: @@ -84,17 +104,15 @@ Mac Java ^^^^ 1. Visit http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html -2. Scroll down to "Java SE Development Kit 8uXXX" (where "XXX" is the latest minor version number) -3. Toggle "Accept License Agreement" -4. Click the download link for jdk-8uXXX-macosx-x64.dmg (where "XXX" is the latest minor version number) -5. Download and run the executable to install Java (use the default settings) -6. Open a new terminal window and run ``java -version`` to test that Java is installed correctly +2. Click the download link for jdk-8uXXX-macosx-x64.dmg (where "XXX" is the latest minor version number) +3. Download and run the executable to install Java (use the default settings) +4. Open a new terminal window and run ``java -version`` to test that Java is installed correctly IntelliJ ^^^^^^^^ 1. Visit https://www.jetbrains.com/idea/download/download-thanks.html?platform=mac&code=IIC 2. Download and run the executable to install IntelliJ Community Edition (use the default settings) -3. Ensure the Kotlin plugin in Intellij is updated to version |kotlin_version| +3. Ensure the Kotlin plugin in Intellij is updated to version |kotlin_version| (new installs will contains this version) .. _deb-ubuntu-label: @@ -123,7 +141,7 @@ Jetbrains offers a pre-built snap package that allows for easy, one-step install 1. To download the snap, navigate to https://snapcraft.io/intellij-idea-community 2. Click ``Install``, then ``View in Desktop Store``. Choose ``Ubuntu Software`` in the Launch Application window. -3. Ensure the Kotlin plugin in Intellij is updated to version |kotlin_version| +3. Ensure the Kotlin plugin in Intellij is updated to version |kotlin_version| (new installs will contains this version) .. _fedora-label: @@ -151,7 +169,7 @@ IntelliJ 1. Visit https://www.jetbrains.com/idea/download/download-thanks.html?platform=linux&code=IIC 2. Unpack the ``tar.gz`` file using the following command ``tar xfz ideaIC-.tar.gz -C /opt`` 3. Run IntelliJ with ``/opt/ideaIC-/bin/idea.sh`` -4. Ensure the Kotlin plugin in IntelliJ is updated to version |kotlin_version| +4. Ensure the Kotlin plugin in IntelliJ is updated to version |kotlin_version| (new installs will contains this version) Next steps