docs: refresh README, Chinese README, and dev guide#140
Merged
Conversation
ravibrock
pushed a commit
to ravibrock/Mouser
that referenced
this pull request
Apr 30, 2026
* docs: clean up readme documentation * docs: compact readme screenshots * docs: refresh chinese readme
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.
Summary
Docs cleanup pass to make the main README more user-friendly and move deeper technical notes into the dev guide.
README.mdwith a TOC, Download & Run first, compact side-by-side screenshots, updated feature/device/action coverage, limitations, roadmap, and creditsDEVELOPMENT.mdwith architecture notes, hook/device/gesture flow, config/logging details, UI overview, project structure, CLI flags, build internals, and debugging tipsREADME_CN.mdto match the new English README structureMouser.lnkshortcut and window-size persistenceCredit
Shoutout to @MysticalMike60t for #123. I borrowed inspo from it for:
<details>build sectionsTesting
git diff --check -- README.md DEVELOPMENT.md README_CN.md