emrg: README simplify — concise ~150 lines, details move to DEVELOPMENT.md - #648
Merged
Conversation
…ced/architecture to DEVELOPMENT.md
argszero
commented
Aug 10, 2026
argszero
left a comment
Owner
Author
There was a problem hiding this comment.
✅ LGTM — cycle
Verified:
- Docs-only: README.md 335→159 lines (concise user-facing), new DEVELOPMENT.md (189 lines, absorbs source installs/architecture/dev workflow), README.cn.md mirrors the new structure section-by-section
- Test counts preserved (pytest 681, GUI 178) — doc-count guard #511 satisfied
- No source code changes; CI (test run 31386941965) SUCCESS
Contributor
|
Tested this PR end-to-end on Windows (local branch @ 0dc1c0a): |
argszero
commented
Aug 10, 2026
Owner
Author
|
Thanks @pm25coder for the Windows end-to-end verification of the README restructure — confirms the doc reorg (README 335→159 + DEVELOPMENT.md 189) doesn't affect install/docs flows on Windows. Test counts remain 681 pytest / 178 GUI as enforced by the #511 doc-count guard. |
argszero
commented
Aug 10, 2026
argszero
left a comment
Owner
Author
There was a problem hiding this comment.
✅ LGTM — cycle
Re-verified (cycle 491):
- Head 0dc1c0a unchanged, mergeable (mergeState CLEAN)
- Docs-only: README.md 335→159 lines, DEVELOPMENT.md (+189), README.cn.md mirror
- Test counts preserved (pytest 681, GUI 178) — doc-count guard #511 satisfied
- CI (test run 31386941965) still SUCCESS
- 3 consecutive LGTMs from different cycles (489, 490, 491) — merge condition met
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
Per user feedback (rant 2026-08-10T20:05:43): the README was too long (335 lines) and full of implementation details — not attractive for users (especially non-developers).
README.md: 335 → 159 lines, keeping only the core appeal:
New DEVELOPMENT.md absorbs all removed detail for contributors/developers: source installs (macOS / Linux / Windows-WSL2), advanced config (config.toml template), architecture + project structure, development workflow (pytest/GUI/CI), extended FAQ.
README.cn.md rewritten to mirror the new concise structure section-by-section (full Chinese, no English residue).
Verification
uv run pytest tests/ -v: 681 passed (incl. test_doc_counts.py guard — README.md/README.cn.md still document pytest=681, GUI=178 with exact breakdown)cd emrg/gui && npm test: 178/178 passedemrg --help: OKNo source code changes — docs only.