release-P4 (P9.4) — the getting-started surface - #117
Merged
Merged
Conversation
README rewritten around the released package instead of the repo build: install via npm (@pirouette/echojs is live at 0.2.0) or the release tarball + install.sh, prerequisites stated once up front, a verified quickstart (hello-world + a multi-module program with relative imports and @node-compat/path — both compiled and run against a dist tarball before being written down), an honest language-support section naming the post-2015 gaps from language-plan's census, and the user-relevant flag/env surface transcribed from the real --help (--types documented as source-checkout-only; the shipped self-hosted binary declines it). Stale CircleCI badge -> GitHub Actions + release badges; the "only builds on OSX" claim replaced by the three-platform CI reality. The dist tarball README points at the quickstart. Gates: //:test-dist green (buck-dist.sh changed); docs otherwise. Follow-on recorded: release automation could stamp the README's pinned version URLs at prepare-release time. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update the README.md to not assume developers building from source