readme-translator

name	readme-translator
description	Generate or update a high-quality Chinese version (README_CN.md) based on the existing README.md. Triggered when the user asks for a Chinese version, translation, or creation of Chinese documentation. Automatically handles language switcher links, technical term translations, and anchor navigation for long documents.

README Translator

This skill automatically generates or updates a Chinese version (README_CN.md) based on the project's README.md.

Workflow

1. Read Content: Read the root README.md of the project.
2. Generate Translation:
   • Maintain the original Markdown structure, code blocks, and image links.
   • Translate technical terms accurately (e.g., "triggers" -> "触发条件", "prerequisites" -> "前提条件").
   • Add a language switcher bar to README_CN.md: [English](README.md) | 中文.
3. Update Original:
   • Add a language switcher bar to the top of README.md: \English | 中文.
4. Structure Optimization:
   • Automatically generate anchor links (Table of Contents or "Skills Quick Link") if the document is long or modular.
   • Ensure maintainer/credits information at the bottom is preserved.
5. Save File: Write the generated content to README_CN.md.

Triggers

• "Provide Chinese version for project README"
• "Translate README"
• "Generate README_CN.md"
• "add Chinese README"
• "create README_CN.md"

Examples

"Help me generate a Chinese README for this project." "Update README_CN.md based on the latest README.md." "Translate the project README to Chinese and add quick-jump links."

Best Practices

• Terminology Consistency: Ensure technical terms are translated consistently throughout the document.
• Link Verification: Ensure all anchor links (#anchor) work correctly in the Chinese context or are adjusted to match Chinese headings.
• Preserve Formatting: Do not alter the core logic, code examples, or licensing information of the original README.