sync-readme

Solid

Synchronize English README.md with Chinese README_ZH.md, maintaining content parity.

AI & Automation 35 stars 1 forks Updated yesterday Unlicense

Install

View on GitHub

Quality Score: 82/100

Stars 20%
52
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 1. **Compare Both Files** - Read README.md and README_ZH.md - Identify sections that differ - Note new sections in either file 2. **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 3. **Translate Content** - Preserve all code blocks unchanged - Translate prose sections accurately - Keep technical terms consistent: - "rules" → "规则" - "commands" → "命令" - "skills" → "技能" - "agents" → "代理" - "instructions" → "指令" - "adapter" → "适配器" - "symbolic link" → "软链接" 4. **Preserve Structure** - Keep same heading hierarchy - Maintain table formats - Preserve all links and badges - Keep code examples identical 5. **Update Language Links** - Ensure language toggle links are present - English: `[English](./README.md) | [中文](./README_ZH.md)` - Chinese: `[English](./README.md) | [中文](./README_ZH.md)` 6. **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 | 命...

Details

Author
lbb00
Repository
lbb00/ai-rules-sync
Created
7 months ago
Last Updated
yesterday
Language
TypeScript
License
Unlicense

Similar Skills

Semantically similar based on skill content — not just same category