Skip to content

docs: add Quick Start build instructions to barretenberg README#20951

Merged
ludamad merged 5 commits intomerge-train/barretenbergfrom
jh/bb-build-docs
Mar 5, 2026
Merged

docs: add Quick Start build instructions to barretenberg README#20951
ludamad merged 5 commits intomerge-train/barretenbergfrom
jh/bb-build-docs

Conversation

@johnathan79717
Copy link
Contributor

@johnathan79717 johnathan79717 commented Feb 27, 2026

Summary

Addresses part 2 of AztecProtocol/barretenberg#1438.
Adds a beginner-friendly Quick Start section with three paths:
- Pre-built binary install via bbup
- Minimal build-from-source recipe
- Docker-based build option
Simpler for non-C++ users — bootstrap.sh handles preset selection
and configuration automatically.
- Merge duplicate Bootstrap section into Quick Start
- Explain that bootstrap.sh requires Zig (clang20 preset)
- Add NATIVE_PRESET=default fallback for users without Zig
The dockerfiles directory it depends on no longer exists.
Also removes the "Testing locally in docker" section.
@johnathan79717 johnathan79717 enabled auto-merge (squash) March 5, 2026 17:22
@johnathan79717 johnathan79717 added ci-barretenberg Run all barretenberg/cpp checks. and removed ci-skip labels Mar 5, 2026
@ludamad ludamad disabled auto-merge March 5, 2026 17:34
@ludamad ludamad merged commit 1c63f3a into merge-train/barretenberg Mar 5, 2026
2 checks passed
@ludamad ludamad deleted the jh/bb-build-docs branch March 5, 2026 17:34
github-merge-queue bot pushed a commit that referenced this pull request Mar 6, 2026
BEGIN_COMMIT_OVERRIDE
fix: add -g0 to zig presets to eliminate 11GB debug info bloat (#21071)
fix: resolve flaky p2p_client test race condition on ARM64 (#21088)
chore: remove domain iteration macros and address backing memory race
(#20988)
fix: [ECCVM] added domain separation for the multiset equality check.
(#20352)
feat: hybrid CRS hash verification — 8MB chunks, parallel, span-based
(#21113)
chore: unify splitting scalars interface (#20805)
chore: add a unique id to each origin tag (#20924)
chore: Native curve audit (#20936)
chore: Update bootstrap in test vk haven't changed script (#21153)
fix: use reduced form in WASM FromMontgomeryForm test (#21164)
chore: erase ephemeral secrets from memory in schnorr and aes (#21106)
chore: suppress clangd target triple version diagnostic (#21180)
feat: Optimise new claim calculation (#21179)
docs: add Quick Start build instructions to barretenberg README (#20951)
feat: batched chonk verification (#21083)
fix: link libc++ instead of libstdc++ for Rust FFI on Linux (#21203)
fix: [ECCVM] in the transcript table, no-ops force the next accumulator
to be 0. (#20849)
fix: resolve merge-train conflict with next (zig wrapper scripts + -g0)
(#21201)
fix: [ECCVM] rare edge case completeness issue when `z1 == 0` but `z2 !=
0` (#20858)
fix: use actual data extent for CommitmentKey in HypernovaDeciderProver
(#21206)
END_COMMIT_OVERRIDE
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-barretenberg Run all barretenberg/cpp checks.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants