Skip to content

Commit

Permalink
Add protoc to build deps in README
Browse files Browse the repository at this point in the history
  • Loading branch information
upbqdn committed Feb 23, 2024
1 parent aaa0783 commit 7594ccf
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,14 @@ Below are quick summaries for installing the dependencies on your machine.
package manager. Typical names are `libclang`, `libclang-dev`, `llvm`, or
`llvm-dev`.
- **clang** or another C++ compiler: `g++` (all platforms) or `Xcode` (macOS).
- **[`protoc`](https://grpc.io/docs/protoc-installation/)**

> [!NOTE]
> Zebra uses the `--experimental_allow_proto3_optional` flag with `protoc`
> during compilation. This flag was introduced in [Protocol Buffers
> v3.12.0](https://github.com/protocolbuffers/protobuf/releases/tag/v3.12.0)
> released in May 16, 2020, so make sure you're not using a version of `protoc`
> older than 3.12.
</details>

Expand All @@ -96,7 +104,7 @@ Below are quick summaries for installing the dependencies on your machine.
</summary>

```sh
sudo pacman -S rust clang
sudo pacman -S rust clang protobuf
```

Note that the package `clang` includes `libclang` as well as the C++ compiler.
Expand Down
6 changes: 0 additions & 6 deletions book/src/user/shielded-scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,6 @@ install the latest release:
cargo install --features shielded-scan --locked --git https://github.com/ZcashFoundation/zebra zebrad
```

> [!NOTE] Enabling the `shielded-scan` feature will make Zebra use the
> `--experimental_allow_proto3_optional` flag of `protoc` during compilation.
> This flag was introduced in [Protocol Buffers
> v3.12.0](https://github.com/protocolbuffers/protobuf/releases/tag/v3.12.0)
> released in May 16, 2020, so make sure you're not using a version of `protoc` older than 3.12.
Zebra binary will be at `~/.cargo/bin/zebrad`, which should be in your `PATH`.

## Configuration
Expand Down

0 comments on commit 7594ccf

Please sign in to comment.