sync-readme

Compares English README.md and Chinese README_zh.md to synchronize translations and formatting.

35|1|Updated Dec 25, 2025
One-click install
npx skills add https://github.com/lbb00/ai-rules-sync --skill sync-readme
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-readme
Source: https://github.com/lbb00/ai-rules-sync/tree/main/.claude/skills/sync-readme
Command: npx skills add https://github.com/lbb00/ai-rules-sync --skill sync-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps keep English README.md and Chinese README_ZH.md in sync, ensuring both languages remain identical in structure and content.

Core Features & Use Cases

  • Parity checks: compare both files and highlight mismatches in sections, links, badges, and code blocks.
  • Synchronized updates: generate or apply translations to maintain alignment between languages when changes occur.
  • Use Case: you update the English README; this Skill helps produce a matching Chinese version and prompts for review to ensure accuracy.

Quick Start

Run the Skill in your repository to compare README.md and README_ZH.md, review suggested updates, and apply changes as needed.

Frequently Asked Questions about sync-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep English and Chinese README files in sync?

To keep English and Chinese README files in sync, you can run a parity check that compares README.md and README_ZH.md, highlighting mismatches in sections, links, badges, and code blocks while generating an actionable update plan.

What is bilingual README parity and how does it work?

Bilingual README parity ensures English README.md and Chinese README_ZH.md remain identical in structure and content by enforcing translation and formatting rules while preserving references, headings, and links across both files.

How do I update a Chinese README to match changes in the English version?

To update a Chinese README to match English changes, you generate synchronized translations that maintain alignment between languages, prompting for review to ensure accuracy before applying the suggested updates.

Does bilingual README synchronization preserve code blocks and badges?

Yes, bilingual README synchronization preserves code blocks and badges by enforcing translation and formatting rules that maintain structural alignment and references across both language files during parity checks.

What is the best way to check for mismatches between bilingual documentation?

The best way to check for mismatches in bilingual documentation is comparing both files to highlight differences in sections, links, badges, and code blocks, then generating an actionable update plan for both languages.