Trim README: cut repetition, consolidate install, move maintainer notes#16
Merged
Conversation
The README had grown to ~365 lines with the same information presented 3-4 times in different framings. First-time readers reported the repetition reading as either defensive or as a signal they'd missed something. This commit: - Cuts the 'Is it actually ready?' section (intro paragraph carries the same value pitch more concisely) - Consolidates 'Install' and 'Get started' into a single Install section (the duplicate at the bottom is removed) - Reduces lazarus-github mentions in core sections from 4 to 1 pointer; the dedicated section does the work - Moves Maintainer Notes to MAINTAINING.md, replaces with a single-line pointer Net: ~365 lines → ~295 lines. Nothing material removed; just repetition consolidated. The Mermaid flowchart, commands table, FAQ, Deep Dive collapsibles, guard section, lazarus-github section, and star CTA are all preserved. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
README was 365 lines with significant repetition. First-time readers had to work to understand whether 'lazarus-github' was required (mentioned 4 times in core sections), and the 'Is it actually ready?' section duplicated the value pitch already made in the intro.
This trims ~70 lines (366 → 295, −19%) while preserving every piece of content that earns its keep:
Preserved:
Net length: ~365 → ~295 lines.
🤖 Generated with Claude Code