sync-readme
Skill37 starsChanged 9 months agoUnlicenseView on GitHub
Synchronize English README.md with Chinese README_ZH.md, maintaining content parity.
3 other projects use a version of this.
Adopted by
Most recently taken up by
- eyeix/skillstheir own version, first seen Oct 13, 2026
- e-dul/opencl-labtheir own version, first seen Mar 23, 2026
- yu-iskw/coding-agent-fabrictheir own version, first seen Feb 5, 2026
Other versions3 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 3
- eyeix/skills★ 1same name
- yu-iskw/coding-agent-fabric★ 1same name
- e-dul/opencl-lab★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository8 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .claude/CLAUDE.mdCLAUDE.md
- .cursor/rules/knowledge-base/RULE.mdCursor rule
- .cursor/rules/project/RULE.mdCursor rule
- new-adapterSkill
- summarize-sessionSkill
- update-docsSkill
- update-knowledge-baseSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
13 rules. About 0 are common, 11 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈11
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 10
Keep the English (README.md) and Chinese (README_ZH.md) documentation in sync.
- Very specific: line 15
Read README.md and README_ZH.md
- Distinctive: line 20
If English was updated more recently: translate EN → ZH
- Distinctive: line 21
If Chinese was updated more recently: translate ZH → EN
- Distinctive: line 22
If unclear, ask user which is the source of truth
- Distinctive: line 27
Keep technical terms consistent:
- Distinctive: line 37
Keep same heading hierarchy
- Distinctive: line 40
Keep code examples identical
- Distinctive: line 43
Ensure language toggle links are present
- Distinctive: line 48
All sections present in both files
- Distinctive: line 49
All features documented in both
- Distinctive: line 75
After running this skill:
- Distinctive: line 77
All features documented in both languages
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Sync README
Purpose
Keep the English (README.md) and Chinese (README_ZH.md) documentation in sync. When one is updated, this skill helps translate and synchronize changes to the other.
Instructions
- Compare Both Files
- Read README.md and README_ZH.md
- Identify sections that differ
- Note new sections in either file
- Determine Sync Direction
- If English was updated more recently: translate EN → ZH
- If Chinese was updated more recently: translate ZH → EN
- If unclear, ask user which is the source of truth
- Translate Content
- Preserve all code blocks unchanged
- Translate prose sections accurately
- Keep technical terms consistent:
- "rules" → "规则"
- "commands" → "命令"
- "skills" → "技能"
- "agents" → "代理"
- "instructions" → "指令"
- "adapter" → "适配器"
- "symbolic link" → "软链接"
- Preserve Structure
- Keep same heading hierarchy
- Maintain table formats
- Preserve all links and badges
- Keep code examples identical
- Update Language Links
- Ensure language toggle links are present
- English:
[English](./README.md) | [中文](./README_ZH.md) - Chinese:
[English](./README.md) | [中文](./README_ZH.md)
- Verify Completeness
- All sections present in both files
- All features documented in both
- Examples work in both versions
Translation Guidelines
Section Headers
| English | Chinese |
| Install | 安装 |
| Commands | 命令 |
| Architecture | 架构 |
| Tab Completion | Tab 补全 |
| Legacy compatibility | Legacy 兼容说明 |
| Supported Sync Types | 支持的同步类型 |
Common Phrases
| English | Chinese |
| Default mapping | 默认映射 |
| Source directory | 源目录 |
| Target directory | 目标目录 |
| Run this command | 运行此命令 |
| This command will | 该命令会 |
Output
After running this skill:
- Both README files contain identical information
- All features documented in both languages
- Formatting consistent across both files
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.