readme

Synchronize English README content with Traditional and Simplified Chinese translations.

17|3|Updated Mar 1, 2026
One-click install
npx skills add https://github.com/ksleungac/pids-jre-simulator --skill readme-ksleungac
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readme
Source: https://github.com/ksleungac/pids-jre-simulator/tree/main/.claude/skills/readme
Command: npx skills add https://github.com/ksleungac/pids-jre-simulator --skill readme-ksleungac

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

README and translations drift over time; this Skill ensures English and localized READMEs stay aligned, extracting language-agnostic content and applying the project's Chinese phrasing preferences.

Core Features & Use Cases

  • Synchronize English README.md with README.zh-HK.md and README.zh-CN.md to maintain consistent structure and terminology.
  • Extract and centralize language-agnostic content (such as ROUTES.md references) to avoid duplication and drift across translations.
  • Enforce the user’s Chinese phrasing preferences during translations to preserve tone and terminology.

Quick Start

Run this skill to synchronize English READMEs with zh-HK and zh-CN versions and extract language-agnostic content.

Frequently Asked Questions about readme

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

FAQPage Schema
How do I keep README files aligned across English and Chinese translations?

To align README files across languages, you validate document structure, mirror sections, and consolidate shared content to prevent translation drift. This synchronization ensures English, Traditional Chinese, and Simplified Chinese versions remain structurally consistent after updates.

How do I extract language-agnostic content from localized Markdown files?

Extract language-agnostic content from Markdown files by identifying shared references like routes and centralizing them in separate files. This avoids content duplication and drift across localized README translations during documentation workflows.

Can I enforce specific Chinese phrasing preferences during README localization?

Yes, you can enforce specific Chinese phrasing preferences during README localization. By applying predefined terminology and tone rules, the localization workflow preserves consistent phrasing across both Traditional Chinese and Simplified Chinese documentation updates.

What is the best way to synchronize English README.md with zh-HK and zh-CN versions?

The best way to synchronize English README.md with zh-HK and zh-CN versions is to validate structural parity and mirror sections after feature changes. This ensures both localized Markdown files reflect the exact same structure as the English source.

When should I run a README localization and synchronization workflow?

You should run a README localization and synchronization workflow after software releases or feature changes. This timing ensures that any structural updates or new content added to the English README are immediately mirrored in the Chinese translations.

Does Markdown documentation synchronization require a specific file structure?

Yes, Markdown documentation synchronization requires a Markdown-friendly file structure. The repository must follow the project's readme skill guidelines to successfully validate structure and extract language-agnostic content without formatting errors.