Skip to content

Commit 95221ae

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

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,19 @@ sdk install java 17.0.2-tem
4848
```sh
4949
bash ./scripts/build-<your-local-architecture>.sh
5050
```
51+
## Run example files
52+
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.
53+
54+
```shell
55+
cd bdk-jvm
56+
./gradlew MultisigTransaction
57+
```
58+
59+
You can also list the application tasks. (All examples grouped under application)
60+
```shell
61+
cd bdk-jvm
62+
./gradlew tasks --group application
63+
```
5164

5265
## How to publish to your local Maven repo
5366

0 commit comments

Comments
 (0)