sync-readme
starsforks
How to install sync-readme?
lbb00/ai-rules-sync/sync-readme
$npx -y skills add lbb00/ai-rules-sync --skill sync-readmeSynchronize English README.md with Chinese README_ZH.md, maintaining content parity.
SKILL.md
| 1 | # Sync README |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | 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. |
| 6 | |
| 7 | ## Instructions |
| 8 | |
| 9 | 1. **Compare Both Files** |
| 10 | - Read README.md and README_ZH.md |
| 11 | - Identify sections that differ |
| 12 | - Note new sections in either file |
| 13 | |
| 14 | 2. **Determine Sync Direction** |
| 15 | - If English was updated more recently: translate EN → ZH |
| 16 | - If Chinese was updated more recently: translate ZH → EN |
| 17 | - If unclear, ask user which is the source of truth |
| 18 | |
| 19 | 3. **Translate Content** |
| 20 | - Preserve all code blocks unchanged |
| 21 | - Translate prose sections accurately |
| 22 | - Keep technical terms consistent: |
| 23 | - "rules" → "规则" |
| 24 | - "commands" → "命令" |
| 25 | - "skills" → "技能" |
| 26 | - "agents" → "代理" |
| 27 | - "instructions" → "指令" |
| 28 | - "adapter" → "适配器" |
| 29 | - "symbolic link" → "软链接" |
| 30 | |
| 31 | 4. **Preserve Structure** |
| 32 | - Keep same heading hierarchy |
| 33 | - Maintain table formats |
| 34 | - Preserve all links and badges |
| 35 | - Keep code examples identical |
| 36 | |
| 37 | 5. **Update Language Links** |
| 38 | - Ensure language toggle links are present |
| 39 | - English: `[English](./README.md) | [中文](./README_ZH.md)` |
| 40 | - Chinese: `[English](./README.md) | [中文](./README_ZH.md)` |
| 41 | |
| 42 | 6. **Verify Completeness** |
| 43 | - All sections present in both files |
| 44 | - All features documented in both |
| 45 | - Examples work in both versions |
| 46 | |
| 47 | ## Translation Guidelines |
| 48 | |
| 49 | ### Section Headers |
| 50 | | English | Chinese | |
| 51 | |---------|---------| |
| 52 | | Install | 安装 | |
| 53 | | Commands | 命令 | |
| 54 | | Architecture | 架构 | |
| 55 | | Tab Completion | Tab 补全 | |
| 56 | | Legacy compatibility | Legacy 兼容说明 | |
| 57 | | Supported Sync Types | 支持的同步类型 | |
| 58 | |
| 59 | ### Common Phrases |
| 60 | | English | Chinese | |
| 61 | |---------|---------| |
| 62 | | Default mapping | 默认映射 | |
| 63 | | Source directory | 源目录 | |
| 64 | | Target directory | 目标目录 | |
| 65 | | Run this command | 运行此命令 | |
| 66 | | This command will | 该命令会 | |
| 67 | |
| 68 | ## Output |
| 69 | |
| 70 | After running this skill: |
| 71 | - Both README files contain identical information |
| 72 | - All features documented in both languages |
| 73 | - Formatting consistent across both files |
People who liked this also viewed
6 picksType
- grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026
- lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026
- lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026
- docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026
- edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026
