Skip to content

Commit c13a681

Browse files
committed
docs: Show how to run examples in readme
1 parent 5d63420 commit c13a681

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,20 @@ sdk install java 17.0.2-tem
4848
```sh
4949
bash ./scripts/build-<your-local-architecture>.sh
5050
```
51+
## Run example files
52+
53+
The `examples` module show different samples of how some of the APIs can be used. You can run the examples after building as stated above. The gradle task to run is by convention the file name of the example file.
54+
55+
```shell
56+
cd bdk-jvm
57+
./gradlew MultisigTransaction
58+
```
59+
60+
You can also list the application tasks. (All examples grouped under application)
61+
```shell
62+
cd bdk-jvm
63+
./gradlew tasks --group application
64+
```
5165

5266
## How to publish to your local Maven repo
5367

examples/build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
22

33
plugins {
4-
kotlin("jvm") version "2.1.10"
5-
application
4+
id("org.jetbrains.kotlin.jvm") version "2.1.10"
5+
id("application")
66
}
77

88
group = "org.bitcoindevkit"

0 commit comments

Comments
 (0)