sync-readmes
Skill1 starsChanged 4 months agoMITView on GitHub
Keep README.md (RU, primary) and README.en.md (EN) structurally in sync after either one changes
In this repository7 other files it gives its agents.
- .claude/CLAUDE.mdCLAUDE.md
- check-scriptsSkill
- releaseSkill
- doctorSkill
- setupSkill
- statusSkill
- uninstallSkill
The file
Files
Sync READMEs
README.md (Russian, primary) and README.en.md (English) describe the
same tool and must have identical structure — same sections, same order,
equivalent content (not a literal translation, but no factual drift: flags,
environment variables, paths, command versions).
Steps
- Compare section headings (
## ...) in both files:
Same set of sections in the same order (headings in their own language is expected; composition/order is not).grep -n '^## ' README.md grep -n '^## ' README.en.md - If only one file was edited — port the change (adapting language and tone) to the other. Technical details (flags, variable names, paths, commands, version numbers, thresholds) must match literally.
- Check the cross-links in the header —
[English](README.en.md)inREADME.mdand[Русский](README.md)inREADME.en.md— both present. - Check that output examples (notifications, statusline,
usage-monitor.sh status) are identical in numbers/structure; only the text language differs. - If the versions/flags/environment-variables section changed, also
cross-check
CHANGELOG.mdanddocs/how-it-works.md, where it may be duplicated.
Done?
Both READMEs read as the same page in two languages.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.