Skip to content

docs: getting started for rustup (Linux, macOS, Windows) - #276

Merged
reardencode merged 1 commit into
masterfrom
docs/getting-started
Aug 26, 2026
Merged

docs: getting started for rustup (Linux, macOS, Windows)#276
reardencode merged 1 commit into
masterfrom
docs/getting-started

Conversation

@rearden-grok

@rearden-grok rearden-grok Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • CONTRIBUTING.md now owns contributor getting started: rustup 1.95, C compiler, clone without --recurse-submodules, first cargo build / --smoke, and a per-OS table (Linux full suite, macOS/flock, Windows Git Bash smoke + WSL2 for cargo test --workspace).
  • Nix is optional. Flake devShells are Linux-only; README Build leads with rustup so a Mac or Windows developer is not sent into nix develop.
  • README, TESTING, OPERATOR, and docs/README.md point at that section instead of duplicating a Nix-only path.

Test plan

  • Skim CONTRIBUTING Getting started as someone with only rustup (no Nix).
  • Confirm README Build → Develop is the first build subsection and links CONTRIBUTING.
  • Docs-only PR: required CI should stay green without code changes.

Made with Cursor

Nix is optional for contributors. CONTRIBUTING owns clone, toolchain,
smoke, and per-OS test surface so a new developer can compile without
the flake. README, TESTING, OPERATOR, and the docs map point there.
@reardencode
reardencode merged commit 67c9a66 into master Aug 26, 2026
13 checks passed
@rearden-grok
rearden-grok Bot deleted the docs/getting-started branch August 26, 2026 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant