docs: toolchain & setup for Linux/macOS/Windows — core + formal-verification track#230
Merged
Conversation
) Core contributor setup (rustup/just/llvm-cov + hooks, with the brew-rust conflict warning from Charon's docs) and the formal-verification track (elan/Lean, opam/OCaml 5, Charon via make setup-charon, Aeneas build), per-OS tables assuming apt/brew/choco. Version pins point at the pin FILES as source of truth rather than hardcoding. Honest verified-state line: Linux exercised; macOS/Windows columns follow upstream docs and are marked unexecuted. WSL2 recommended for the OCaml leg on Windows. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
docs/TOOLCHAIN.md: setup instructions for Linux (apt), macOS(brew), Windows (choco) covering:
the brew-
rust-vs-rustupconflict warning (lifted from Charon's owndocs), Windows POSIX-shell note (Git Bash or WSL2).
lean-toolchain), opam/OCaml 5 switch + the Aeneas dependency set,Charon via
make setup-charon(the pin file owns the commit; nohand-cloning), Aeneas build, and an end-to-end smoke checklist.
(charon
rust-toolchain.toml, aeneascharon-pin,backends/lean/lean-toolchain) instead of hardcoding versions thatwould drift.
Windows columns follow upstream documentation and are marked unexecuted.
WSL2 is the recommended path for the OCaml leg on Windows.
Test plan
just checkpassed via the pre-push hook.design: agent-* libraries expose decision surfaces (structs/seams), never TUIs #225 readiness pass; Charon/Aeneas steps cross-checked against both
upstream READMEs at today's HEAD.
Out of scope
Refs #225. Companion to #229 (the obligations this toolchain discharges).