Skip to content

docs: document direct-download native binaries in README#111

Merged
tig merged 2 commits intodevelopfrom
docs/readme-native-binaries
May 8, 2026
Merged

docs: document direct-download native binaries in README#111
tig merged 2 commits intodevelopfrom
docs/readme-native-binaries

Conversation

@tig
Copy link
Copy Markdown
Member

@tig tig commented May 8, 2026

Summary

  • Add an Install → Native binaries (direct download) subsection covering the three NativeAOT archives (osx-arm64.tar.gz, linux-x64.tar.gz, win-x64.zip) that already ship with every GitHub release.
  • Per-platform install snippets: curl + tar + xattr -d com.apple.quarantine for macOS, curl + tar + chmod for Linux, Invoke-WebRequest + Expand-Archive for Windows.
  • Call out the unsigned status (Gatekeeper / SmartScreen warnings expected) and point users who want signed binaries at brew / winget / dotnet tool install.
  • Cross-link from the existing "Do I need .NET installed?" FAQ so readers landing in the FAQ find the new section.

Why

Releases have shipped these binaries since the v0.5 / Makefile work merged, but the README only documented brew, winget, and dotnet tool install. Users (and AI agents) who want a no-runtime, no-package-manager install path had no instructions and no warning about the missing code signing.

Doc-update gate

  • No CLI surface, exit code, or JSON envelope changes — specs/clet-spec.md not touched.
  • No test layout changes — tests/SPEC.md not touched.
  • Code signing is still deferred per memory + decisions log; this PR only documents the current unsigned reality.

Test plan

  • Render the README on the PR page and confirm the new section + table look right.
  • Spot-check that the FAQ cross-link anchor (#native-binaries-direct-download) resolves on github.com.

tig and others added 2 commits May 7, 2026 18:04
Each GitHub release ships unsigned NativeAOT binaries for osx-arm64,
linux-x64, and win-x64, but the README only covered brew / winget /
dotnet tool. Add an Install subsection with per-platform download
snippets (curl/tar, Invoke-WebRequest), call out the missing code
signing and the Gatekeeper/SmartScreen workarounds, and cross-link
from the existing "Do I need .NET installed?" FAQ.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Move the detailed native binary install instructions out of the Install
section to reduce clutter, keeping a short note with an anchor link.
Document that libonigwrap is optional (syntax highlighting only) and
fix the binary size from ~8 MB to ~20 MB.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@tig tig merged commit 43f9b40 into develop May 8, 2026
4 checks passed
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