From 8b22e057bfbeeb591e1307f9fab232ffdc6a1047 Mon Sep 17 00:00:00 2001 From: Craig Raw Date: Thu, 4 Aug 2022 14:35:59 +0200 Subject: [PATCH] update documentation to reference java 18.0.1 as current release jdk --- README.md | 16 ++++++++-------- docs/reproducible.md | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1cdccd4b..b51754a5 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ or for those without SSH credentials: `git clone --recursive https://github.com/sparrowwallet/sparrow.git` -In order to build, Sparrow requires Java 17 to be installed. -The release binaries are built with [Eclipse Temurin 17.0.2+8](https://github.com/adoptium/temurin17-binaries/releases/tag/jdk-17.0.2%2B8). +In order to build, Sparrow requires Java 17 or higher to be installed. +The release binaries are built with [Eclipse Temurin 18.0.1+10](https://github.com/adoptium/temurin18-binaries/releases/tag/jdk-18.0.1%2B10). Other packages may also be necessary to build depending on the platform. On Debian/Ubuntu systems: @@ -36,7 +36,7 @@ When updating to the latest HEAD The release binaries are reproducible from v1.5.0 onwards (pre codesigning and installer packaging). More detailed [instructions on reproducing the binaries](docs/reproducible.md) are provided. -> A video documention of your built process uploaded to [bitcoinbinary.org](https://bitcoinbinary.org/) is appreciated. Alternatively check the site if you wish to see if someone else already verified the provided binaries. +> Video documentation of your build process uploaded to [bitcoinbinary.org](https://bitcoinbinary.org/) is appreciated. Alternatively check the site if you wish to see if someone else already verified the provided binaries. ## Running @@ -77,11 +77,11 @@ Note that if you are connecting to an Electrum server when using testnet, that s When not explicitly configured using the command line argument above, Sparrow stores its mainnet config file, log file and wallets in a home folder location appropriate to the operating system: -Platform | Location --------- | -------- -OSX | ~/.sparrow -Linux | ~/.sparrow -Windows | %APPDATA%/Sparrow +| Platform | Location | +|----------| -------- | +| OSX | ~/.sparrow | +| Linux | ~/.sparrow | +| Windows | %APPDATA%/Sparrow | Testnet, regtest and signet configurations (along with their wallets) are stored in subfolders to allow easy switching between networks. diff --git a/docs/reproducible.md b/docs/reproducible.md index e64850d2..d1c8224c 100644 --- a/docs/reproducible.md +++ b/docs/reproducible.md @@ -12,14 +12,14 @@ Work on resolving both of these issues is ongoing. #### Install Java Because Sparrow bundles a Java runtime in the release binaries, it is essential to have the same version of Java installed when creating the release. -For v1.6.4 and later, this is Eclipse Temurin 17.0.2+8. -It is available for all supported platforms from [Eclipse Temurin 17.0.2+8](https://github.com/adoptium/temurin17-binaries/releases/tag/jdk-17.0.2%2B8). +For v1.6.6 and later, this is Eclipse Temurin 18.0.1+10. +It is available for all supported platforms from [Eclipse Temurin 18.0.1+10](https://github.com/adoptium/temurin18-binaries/releases/tag/jdk-18.0.1%2B10). For reference, the downloads are as follows: -- [Linux x64](https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.2%2B8/OpenJDK17U-jdk_x64_linux_hotspot_17.0.2_8.tar.gz) -- [MacOS x64](https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.2%2B8/OpenJDK17U-jdk_x64_mac_hotspot_17.0.2_8.tar.gz) -- [MacOS aarch64](https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.2%2B8/OpenJDK17U-jdk_aarch64_mac_hotspot_17.0.2_8.tar.gz) -- [Windows x64](https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.2%2B8/OpenJDK17U-jdk_x64_windows_hotspot_17.0.2_8.zip) +- [Linux x64](https://github.com/adoptium/temurin18-binaries/releases/download/jdk-18.0.1%2B10/OpenJDK18U-jdk_x64_linux_hotspot_18.0.1_10.tar.gz) +- [MacOS x64](https://github.com/adoptium/temurin18-binaries/releases/download/jdk-18.0.1%2B10/OpenJDK18U-jdk_x64_mac_hotspot_18.0.1_10.tar.gz) +- [MacOS aarch64](https://github.com/adoptium/temurin18-binaries/releases/download/jdk-18.0.1%2B10/OpenJDK18U-jdk_aarch64_mac_hotspot_18.0.1_10.tar.gz) +- [Windows x64](https://github.com/adoptium/temurin18-binaries/releases/download/jdk-18.0.1%2B10/OpenJDK18U-jdk_x64_windows_hotspot_18.0.1_10.zip) It is also possible to install via a package manager on *nix systems. For example, on Debian/Ubuntu systems: ```shell @@ -27,7 +27,7 @@ sudo apt-get install -y wget apt-transport-https gnupg wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add - echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list sudo apt update -y -sudo apt-get install -y temurin-17-jdk=17.0.2+8 +sudo apt-get install -y temurin-17-jdk=18.0.1+10 sudo update-alternatives --config java ``` @@ -35,7 +35,7 @@ A alternative option for all platforms is to use the [sdkman.io](https://sdkman. See the installation [instructions here](https://sdkman.io/install). Once installed, run ```shell -sdk install java 17.0.2-tem +sdk install java 18.0.1-tem ``` #### Other requirements