Skip to content

Commit 212df6a

Browse files
committed
Merge #246: doc: add installation prerequisite to Readme
0725724 docs: Update stated bdk_wallet version (Vihiga Tyonum) d787fa0 doc: added prerequisites to readme (oscar) Pull request description: <!-- You can erase any parts of this template not applicable to your Pull Request. --> ### Description This is a continuation of #221 <!-- Describe the purpose of this PR, what's being adding and/or fixed --> ### Notes to the reviewers <!-- In this section you can include notes directed to the reviewers, like explaining why some parts of the PR were done in a specific way --> - Update the stated `bdk_wallet` to 2.x.x - Addressed review comments on #221 ## Changelog notice <!-- Notice the release manager should include in the release tag message changelog --> <!-- See https://keepachangelog.com/en/1.0.0/ for examples --> ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk-cli/blob/master/CONTRIBUTING.md) * [x] I ran `cargo fmt` and `cargo clippy` before committing ACKs for top commit: notmandatory: ACK 0725724 Tree-SHA512: a0446a915c8c2553ea4612d9e2382e8d3212c73929be9944c9cb965f0fbf2620df339d3284796cf7315bdb65ca5a364a299ba8bfacb3edd3694c2bd796b0fae0
2 parents 46e1ab7 + 0725724 commit 212df6a

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
## About
2828

2929
**EXPERIMENTAL**
30-
This crate has been updated to use `bdk_wallet` 1.x. Only use for testing on test networks.
30+
31+
This crate has been updated to use `bdk_wallet` 2.x. Only use for testing on test networks.
3132

3233
This project provides a command-line Bitcoin wallet application using the latest [BDK Wallet APIs](https://docs.rs/bdk_wallet/1.0.0/bdk_wallet/index.html) and chain sources ([RPC](https://docs.rs/bdk_bitcoind_rpc/0.18.0/bdk_bitcoind_rpc/index.html), [Electrum](https://docs.rs/bdk_electrum/0.21.0/bdk_electrum/index.html), [Esplora](https://docs.rs/bdk_esplora/0.21.0/bdk_esplora/), [Kyoto](https://docs.rs/bdk_kyoto/0.9.0/bdk_kyoto/)). This might look tiny and innocent, but by harnessing the power of BDK it provides a powerful generic descriptor based command line wallet tool.
3334
And yes, it can do Taproot!!
@@ -57,6 +58,14 @@ The `default` feature set is `repl` and `sqlite`. With the `default` features, `
5758

5859
## Install bdk-cli
5960

61+
### Prerequisites
62+
63+
Building BDK requires `gcc`. If you do not have this installed run:
64+
65+
```shell
66+
sudo apt-get install build-essential
67+
```
68+
6069
### From source
6170

6271
To install a dev version of `bdk-cli` from a local git repo with the `electrum` blockchain client enabled:
@@ -83,6 +92,7 @@ Available blockchain client features are:
8392
`electrum`, `esplora`, `kyoto`, `rpc`.
8493

8594
### From crates.io
95+
8696
You can install the binary for the latest tag of `bdk-cli` with online wallet features
8797
directly from [crates.io](https://crates.io/crates/bdk-cli) with a command as below:
8898
```sh

0 commit comments

Comments
 (0)