Skip to content

Commit b1fdd2d

Browse files
authored
Merge pull request #17 from Sjors/2026/03/doc
doc: document Cap'n Proto build prerequisites
2 parents 0136bea + 7365be9 commit b1fdd2d

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
## Bitcoin Cap'n Proto Rust Client
22

3-
This project auto-generates the client code to interact with Bitcoin Core in Rust using interprocess communication. To build the code locally, you will need to have the [`capnp`](https://capnproto.org/install.html) compiler installed on your system.
3+
This project auto-generates the client code to interact with Bitcoin Core in Rust using interprocess communication.
4+
5+
## Build prerequisites
6+
7+
Building this crate requires the [`capnp`](https://capnproto.org/install.html)
8+
compiler.
9+
10+
macOS:
11+
12+
```sh
13+
brew install capnp
14+
```
15+
16+
Debian / Ubuntu:
17+
18+
```sh
19+
sudo apt-get install capnproto libcapnp-dev
20+
```
21+
22+
If `/capnp/c++.capnp` cannot be found during `cargo build`, install the
23+
platform's Cap'n Proto development package in addition to the compiler.
424

525
## Minimum Standard Rust Version
626

0 commit comments

Comments
 (0)