Repository navigation
[docs] Align README build commands with CONTRIBUTING.md #1515
Description
Brief description of your issue
The "Building from source" examples in README.md differ from the commands documented in CONTRIBUTING.md:
- Windows:
build.bat --allis described as building for the current architecture, but it builds both x64 and ARM64. - macOS:
./build-mac.sh --allis described as building for the native architecture, but it builds both ARM64 and x64. - Linux:
./build.sh --allexits withUnknown option: --all.
CONTRIBUTING.md already documents the default release builds correctly: build.bat, ./build-mac.sh, and ./build.sh, without --all.
I'd like to update the README examples to match those commands, keeping the existing descriptions. This would be a documentation-only change.
Related: build-command inconsistencies were also noted during review of #1437.
I'm happy to submit a PR if this approach looks good.
Activity
bbonaby commentedon Oct 23, 2026
Thanks for opening this issue and for offering to put together the fix! The proposed documentation update looks reasonable.
We're currently working through how we want to handle and coordinate external contributions to the repository, so we'd like to hold off on assigning this for now. We'll follow up here once we've aligned on the process and ownership for this work.
Thanks for checking with us before starting on the PR!