lbb00

sync-readme

6
0
# Install this skill:
npx skills add lbb00/ai-rules-sync --skill "sync-readme"

Install specific skill from multi-skill repository

# Description

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

# SKILL.md


name: sync-readme
description: Synchronize English README.md with Chinese README_ZH.md, maintaining content parity.


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
  2. Read README.md and README_ZH.md
  3. Identify sections that differ
  4. Note new sections in either file

  5. Determine Sync Direction

  6. If English was updated more recently: translate EN → ZH
  7. If Chinese was updated more recently: translate ZH → EN
  8. If unclear, ask user which is the source of truth

  9. Translate Content

  10. Preserve all code blocks unchanged
  11. Translate prose sections accurately
  12. Keep technical terms consistent:

    • "rules" → "规则"
    • "commands" → "命令"
    • "skills" → "技能"
    • "agents" → "代理"
    • "instructions" → "指令"
    • "adapter" → "适配器"
    • "symbolic link" → "软链接"
  13. Preserve Structure

  14. Keep same heading hierarchy
  15. Maintain table formats
  16. Preserve all links and badges
  17. Keep code examples identical

  18. Update Language Links

  19. Ensure language toggle links are present
  20. English: [English](./README.md) | [中文](./README_ZH.md)
  21. Chinese: [English](./README.md) | [中文](./README_ZH.md)

  22. Verify Completeness

  23. All sections present in both files
  24. All features documented in both
  25. 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

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.