From d8718c3f05801593c3f506cb20cb8aaf6e22ffbb Mon Sep 17 00:00:00 2001 From: David Sterling <128665635+DavidPSterling@users.noreply.github.com> Date: Sun, 23 Apr 2023 09:25:19 +0700 Subject: [PATCH] Update bdk-jvm README build instructions The current build instructions for bdk-jvm are insufficient for someone to build bdk-jvm from scratch. It's not outlined that JDK 11 and Rust is required on the system. --- bdk-jvm/README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/bdk-jvm/README.md b/bdk-jvm/README.md index a9a7e36..855d9f0 100644 --- a/bdk-jvm/README.md +++ b/bdk-jvm/README.md @@ -49,17 +49,25 @@ dependencies { ## How to build _Note that Kotlin version `1.6.10` or later is required to build the library._ - -1. Clone this repository. +1. Install JDK 11. It must be JDK 11 (not 17), otherwise it won't build. For example, with SDKMAN!: +```shell +curl -s "https://get.sdkman.io" | bash +source "$HOME/.sdkman/bin/sdkman-init.sh" +sdk install java 11.0.19-tem +``` +2. Install rust: +```shell +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +``` +3. Clone this repository. ```shell git clone https://github.com/bitcoindevkit/bdk-ffi ``` -2. Follow the "General" bdk-ffi ["Getting Started (Developer)"] instructions. -3. If building on macOS install required intel and m1 jvm targets +4. If building on macOS install required intel and m1 jvm targets ```sh rustup target add x86_64-apple-darwin aarch64-apple-darwin ``` -4. Build kotlin bindings +5. Build kotlin bindings ```sh # build JVM library ./gradlew buildJvmLib