Skip to content

[codex] Clarify source checkout install flow - #5

Draft
Erwin2233 wants to merge 1 commit into
mainfrom
codex/update-readme-install-docs
Draft

[codex] Clarify source checkout install flow#5
Erwin2233 wants to merge 1 commit into
mainfrom
codex/update-readme-install-docs

Conversation

@Erwin2233

Copy link
Copy Markdown
Collaborator

What changed

This updates the installation documentation in both English and Chinese README files.

  • Clarifies the published package install path.
  • Updates the pnpm requirement from 9+ to 10+.
  • Adds a source-checkout run path for developers who are working without a prebuilt dist/ tree.
  • Notes that team control-plane commands in the public CLI are still stabilizing.

Why

A source checkout can be confused with a packaged release because ./velaclaw.mjs expects built output. The README now gives explicit development commands so contributors can run the CLI reliably from source.

Validation

  • git diff --check -- README.md README.zh-CN.md
  • pre-commit hook detected docs-only changes and skipped pnpm checks

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