Skip to content

docs: refresh README for self-containment + Track C wheels#3

Open
rafael5 wants to merge 1 commit into
mainfrom
docs/readme-refresh
Open

docs: refresh README for self-containment + Track C wheels#3
rafael5 wants to merge 1 commit into
mainfrom
docs/readme-refresh

Conversation

@rafael5
Copy link
Copy Markdown
Collaborator

@rafael5 rafael5 commented May 9, 2026

Summary

Brings the README in line with what's actually shipped:

  • Broken refs to non-existent projects:
    • m-standard ../m-standard relative link → GitHub URL.
    • All "sibling project tree-sitter-m-lint" mentions removed; standards enforcement actually lives in m-cli's `m lint`.
    • Relationship-family ASCII diagram updated accordingly.
  • Stale Python distribution claim: replaces "Python binding consumed via local checkout — no PyPI publication planned" with the actual Track C channel: prebuilt wheels (cibuildwheel, cp310-abi3) attached to each GitHub Release; example install line now uses the v0.1.1 wheel URL.
  • Stale prebuilds claim: removes "wired but not yet running in CI"; `prebuilds.yml` is firing on every `v*` tag, and v0.1.1 already shipped four Node prebuilds + four Python wheels.
  • Personal-path leak: build examples no longer hardcode `/vista-meta/...`; default corpus is `/projects/m-modern-corpus` (in-org).

No code changes, no behavioural changes — README only.

Test plan

  • Render the README on GitHub and skim for visual breakage.
  • Click the `m-standard` link to confirm it resolves.

🤖 Generated with Claude Code

Fixes references to projects that don't exist in m-dev-tools and stale
distribution claims:

- m-standard ../m-standard → GitHub URL.
- "Sibling project tree-sitter-m-lint" mentions removed; standards
  enforcement actually lives in m-cli's `m lint`.
- Relationship-family ASCII diagram updated: tree-sitter-m-lint slot
  replaced with the real downstream consumers (m-cli, the two VS Code
  extensions). Python install line changed from "clone-and-install,
  no PyPI" to "wheel attached to GitHub Release".
- Build example commands no longer hardcode ~/vista-meta/...; default
  the corpus to ~/projects/m-modern-corpus (in-org).
- Python install section: replaces "no PyPI publication planned" with
  the cibuildwheel/abi3 release-asset URL pattern landed in Track C.
- Prebuilt-binaries section: prebuilds.yml is wired and v0.1.1 ships
  wheels + N-API tarballs; replaces the older "not yet running in CI"
  caveat.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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