From a40e69cca020e3628e5becea1357756a9d17abb2 Mon Sep 17 00:00:00 2001 From: Julius <74841960+JuliusZhou124@users.noreply.github.com> Date: Tue, 3 Dec 2024 19:27:10 -0800 Subject: [PATCH] Update docs to suggest JDK 17 (#1611) #1609 #1604 --- .../docs/advanced-installation/sw_install/linux-pc.md | 6 +++--- .../docs/advanced-installation/sw_install/mac-os.md | 6 +++--- .../docs/advanced-installation/sw_install/windows-pc.md | 8 ++++++-- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/source/docs/advanced-installation/sw_install/linux-pc.md b/docs/source/docs/advanced-installation/sw_install/linux-pc.md index 3c6e63e4a..729934427 100644 --- a/docs/source/docs/advanced-installation/sw_install/linux-pc.md +++ b/docs/source/docs/advanced-installation/sw_install/linux-pc.md @@ -8,14 +8,14 @@ You do not need to install PhotonVision on a Windows PC in order to access the w ## Installing Java -PhotonVision requires a JDK installed and on the system path. JDK 11 is needed (different versions will not work). If you don't have JDK 11 already, run the following to install it: +PhotonVision requires a JDK installed and on the system path. JDK 17 is needed (different versions will not work). If you don't have JDK 17 already, run the following to install it: ``` -$ sudo apt-get install openjdk-11-jdk +$ sudo apt-get install openjdk-17-jdk ``` :::{warning} -Using a JDK other than JDK11 will cause issues when running PhotonVision and is not supported. +Using a JDK other than JDK17 will cause issues when running PhotonVision and is not supported. ::: ## Downloading the Latest Stable Release of PhotonVision diff --git a/docs/source/docs/advanced-installation/sw_install/mac-os.md b/docs/source/docs/advanced-installation/sw_install/mac-os.md index 8c2c7b342..55431b4a6 100644 --- a/docs/source/docs/advanced-installation/sw_install/mac-os.md +++ b/docs/source/docs/advanced-installation/sw_install/mac-os.md @@ -5,17 +5,17 @@ Due to current [cscore](https://github.com/wpilibsuite/allwpilib/tree/main/cscor ::: :::{note} -You do not need to install PhotonVision on a Windows PC in order to access the webdashboard (assuming you are using an external coprocessor like a Raspberry Pi). +You do not need to install PhotonVision on a Mac in order to access the webdashboard (assuming you are using an external coprocessor like a Raspberry Pi). ::: VERY Limited macOS support is available. ## Installing Java -PhotonVision requires a JDK installed and on the system path. JDK 11 is needed (different versions will not work). You may already have this if you have installed WPILib. If not, [download and install it from here](https://adoptium.net/temurin/releases?version=11). +PhotonVision requires a JDK installed and on the system path. JDK 17 is needed (different versions will not work). You may already have this if you have installed WPILib 2025+. If not, [download and install it from here](https://adoptium.net/temurin/releases?version=17). :::{warning} -Using a JDK other than JDK11 will cause issues when running PhotonVision and is not supported. +Using a JDK other than JDK17 will cause issues when running PhotonVision and is not supported. ::: ## Downloading the Latest Stable Release of PhotonVision diff --git a/docs/source/docs/advanced-installation/sw_install/windows-pc.md b/docs/source/docs/advanced-installation/sw_install/windows-pc.md index 9bfde737c..ce9e74303 100644 --- a/docs/source/docs/advanced-installation/sw_install/windows-pc.md +++ b/docs/source/docs/advanced-installation/sw_install/windows-pc.md @@ -12,10 +12,14 @@ Bonjour provides more stable networking when using Windows PCs. Install [Bonjour ## Installing Java -PhotonVision requires a JDK installed and on the system path. **JDK 11 is needed** (different versions will not work). You may already have this if you have installed WPILib, but ensure that running `java -version` shows JDK 11. If not, [download and install it from here](https://adoptium.net/temurin/releases?version=11) and ensure that the new JDK is being used. +PhotonVision requires a JDK installed and on the system path. **JDK 17 is needed. Windows Users must use the JDK that ships with WPILib.** [Download and install it from here.](https://github.com/wpilibsuite/allwpilib/releases/tag/v2025.1.1-beta-2) Either ensure the only Java on your PATH is the WPILIB Java or specify it to gradle with `-Dorg.gradle.java.home=C:\Users\Public\wpilib\2025\jdk`: + +``` +> ./gradlew run "-Dorg.gradle.java.home=C:\Users\Public\wpilib\2025\jdk" +``` :::{warning} -Using a JDK other than JDK11 will cause issues when running PhotonVision and is not supported. +Using a JDK other than WPILIB's JDK17 will cause issues when running PhotonVision and is not supported. ::: ## Downloading the Latest Stable Release of PhotonVision