Skip to content

Commit 98bef7e

Browse files
committed
chore(add-justfile): update README
- update readme to include just command runner
1 parent ef84b92 commit 98bef7e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,21 @@ To generate a new extended master key, suitable for use in a descriptor:
113113
cargo run -- key generate
114114
```
115115

116+
## Justfile
117+
118+
We have added the `just` command runner to help you with common commands (during development) and running regtest `bitcoind` if you are using the `rpc` feature.
119+
Visit the [just](https://just.systems/man/en/packages.html) page for setup instructions.
120+
121+
The below are some of the commands included:
122+
123+
``` shell
124+
just # list all available recipes
125+
just start # start regtest bitcoind in default dir
126+
just test # test the project
127+
just build # build the project
128+
```
129+
130+
116131
## Minimum Supported Rust Version (MSRV)
117132

118133
This library should always compile with any valid combination of features on Rust **1.75.0**.

0 commit comments

Comments
 (0)