Rewrite README: shorter, current, and organized by reader - #1106
Merged
Merged
Conversation
Cut from 765 to 221 lines. The module-by-module layout belongs in ARCHITECTURE.md, the theorem lists in the generated catalog, and open work in GitHub issues; the README now points to those. Drop the Lean 4.34 port notes and the history-style roadmap and bibliography. All development, CI, documentation, and cleanliness rules are kept, grouped as short lists. Co-Authored-By: Claude Opus 5.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.
The README had grown to 765 lines with overlapping sections: a module-by-module layout, port notes, a long theorem inventory, and a history-style roadmap. This rewrite brings it to 221 lines.
Structure: intro and catalog link → Build → Layout → Main concepts → Selected results → Contributing (proof status, code rules, checks, CI/PRs, documentation, cleanliness) → License.
Moved out, not lost
ARCHITECTURE.md, which already covers it.mainand on the open wrapper-cleanup branches Hurwitz/Hadamard cluster: state proved results directly, drop Statement wrappers #1093, Liu: state x-subtraction, quartic boundary and root-order lemmas directly (part 2) #1100, CommonInterleaver: state the Chudnovsky–Seymour pair chain directly (part 2) #1101 and Remove Statement-wrapper scaffolding (GeneralizedSnakePosets) #1099.Dropped: the Lean 4.34 port notes (
List.interleaveRight,IsTotallyNonneg.smul), the stale "useful focused checks" list, and the bibliography. Each catalog page carries its own references.Kept verbatim in substance: every development and CI rule. These cover the
sorry/axiom/Statementpolicy, the forbiddenset_option/try/all_goals/any_goals/simp +decide,liaoveromegawithALLOWED_OMEGA, warnings as errors, no absolute paths, CI-first drafts, merge requirements, catalog rules, and cleanliness.AGENTS.mdgives the README precedence, so none of these were weakened.Documentation only. No script or workflow reads
README.md.🤖 Generated with Claude Code