Make README the project front door - #117
Merged
Merged
Conversation
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
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.
Summary
Why
The README was accurate but combined onboarding, usage, language details, development commands, layout, and release maintenance in one page. This makes the repository easier to scan while preserving and expanding the technical material in documents with clear ownership.
User and developer impact
Users get a shorter entry point, clearer installation and CLI guidance, and a detailed supported-language reference. Contributors get an implementation-backed walkthrough of the source-preparation, lexer, parser, AST, and evaluator pipeline. Product behavior is unchanged.
Validation
git diff --checkmake check— vet, race tests, 82.9% coverage, zero lint issuesmake fuzzmake buildmake release-check VERSION=docsmake corpus-smoke— all 112 byte-distinct variants passedmake vuln— no vulnerabilities found