docs: update README compatibility and platform status - #2324
Conversation
There was a problem hiding this comment.
Review: README compatibility rewrite
This is a documentation-only change (README.md, +53/-93) that retitles the project, restructures the compatibility narrative (new Project status and Go standard library support sections, dropped the long hand-maintained "Go packages support" list and the standalone "Defer" subsection), bumps documented dependencies (Go 1.24+, LLVM/Clang/LLD 19, adds libffi/libuv), and reframes Windows as unsupported.
Verification against the codebase (all confirmed accurate):
- Referenced paths exist:
test/goroot/README.md,xfail.yaml,notapplicable.yaml,test/std/README.md,doc/Embedded_Cmd.md. go.moddeclaresgo 1.24.0; CI pins Go1.24.11+1.26.5(both released stable releases in this repo state — not gotip), matching the "pinned Go 1.24 and Go 1.26 toolchains" claim.- LLVM/Clang/LLD 19, libffi, and libuv match the install scripts and
setup-depsaction; the macOS embedme block (llvm@19 lld@19) is consistent. - GC default (conservative BDWGC +
nogctag) and the 1:1 goroutine/OS-thread model match the runtime. - Internal anchors
#project-statusand#development-toolsresolve; the XGo link was correctly updated togoplus/xgo.
Overall: accurate, well-structured, and safe to merge. One minor redundancy noted inline; no blocking issues.
LLGo baseline benchmarks
Program measurements
Core language and compiler benchmarks
Compared with |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Summary
Validation
bash doc/_readme/scripts/check_std_cover.sh(176/176 public packages)npx --yes embedme --verify README.mdlychee --max-concurrency 3 --retry-wait-time 15 README.md(0 errors)git diff --check