Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update docs for building Zebra #8315

Merged
merged 3 commits into from
Feb 23, 2024
Merged

chore: Update docs for building Zebra #8315

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7929273
Update build instructions with scanning enabled
upbqdn Feb 22, 2024
aaa0783
Remove `pkg-config` from build deps in README
upbqdn Feb 23, 2024
7594ccf
Add `protoc` to build deps in README
upbqdn Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion book/src/user/shielded-scan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ keys for experimental use or publicly known keys.

## Build & Install

Use [Zebra 1.5.0](https://github.com/ZcashFoundation/zebra/releases/tag/v1.5.0)
Use [Zebra 1.6.0](https://github.com/ZcashFoundation/zebra/releases/tag/v1.6.0)
or greater, or the `main` branch to get the latest features, and enable the
`shielded-scan` feature during the build. You can also use Rust's `cargo` to
install the latest release:
Expand All @@ -24,6 +24,12 @@ 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
arya2 marked this conversation as resolved.
Show resolved Hide resolved
> `--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
Loading