Skip to content

Commit 039b64d

Browse files
Update JVM readme with specific Rust version
1 parent fe7e4e2 commit 039b64d

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

bdk-jvm/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# bdk-android
1+
# bdk-jvm
22
This project builds a .jar package for the JVM platform that provide Kotlin language bindings for the [`bdk`] library. The Kotlin language bindings are created by the `bdk-ffi` project which is included in the root of this repository.
33

44
## How to Use
@@ -43,21 +43,21 @@ dependencies {
4343
}
4444
```
4545

46-
4746
## Example Projects
4847
* [Tatooine Faucet](https://github.com/thunderbiscuit/tatooine)
4948

5049
## How to build
5150
_Note that Kotlin version `1.6.10` or later is required to build the library._
52-
1. Install JDK 11. It must be JDK 11 (not 17), otherwise it won't build. For example, with SDKMAN!:
51+
1. Install JDK 11. It must be version 11 (not 17), otherwise it won't build. For example, with SDKMAN!:
5352
```shell
5453
curl -s "https://get.sdkman.io" | bash
5554
source "$HOME/.sdkman/bin/sdkman-init.sh"
5655
sdk install java 11.0.19-tem
5756
```
58-
2. Install rust:
57+
2. Install Rust (note that we are currently building using Rust 1.67.0):
5958
```shell
6059
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
60+
rustup default 1.67.0
6161
```
6262
3. Clone this repository.
6363
```shell
@@ -68,10 +68,9 @@ git clone https://github.com/bitcoindevkit/bdk-ffi
6868
rustup target add x86_64-apple-darwin aarch64-apple-darwin
6969
```
7070
5. Build kotlin bindings
71-
```sh
72-
# build JVM library
73-
./gradlew buildJvmLib
74-
```
71+
```sh
72+
./gradlew buildJvmLib
73+
```
7574

7675
## How to publish to your local Maven repo
7776
```shell

0 commit comments

Comments
 (0)