agentleFS
Sign inStart free
YangsonHungYangsonHung/awesome-agent-skills/skills/en/multi-lang-readme/SKILL.md

multi-lang-readme

Skill18 starsChanged 6 days agoMITView on GitHub

Use when creating bilingual or multilingual README files from an existing README while preserving Markdown structure.

The file

Show its rules and text

We split this skill into the rules it gives an agent

21 rules. About 0 are common, 21 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈21

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Create multilingual README files by translating an existing README while preserving Markdown structure, links, code blocks, and …

    line 10
  2. Distinctive:

    Use this skill when the user asks for:

    line 14
  3. Distinctive:

    Do not use this skill for:

    line 22
  4. Distinctive:

    Write translated files using language suffix conventions.

    line 32
  5. Distinctive:

    Add or update language-switch links at the top of each README.

    line 33
  6. Distinctive:

    Verify filenames, link paths, and formatting before final output.

    line 34
  7. Distinctive:

    Check root directory for README.md

    line 51
  8. Distinctive:

    If multiple README files exist, ask which file should be translated

    line 52
  9. Distinctive:

    Read full markdown content, including:

    line 56
  10. Distinctive:

    All sections (Features, Installation, Usage, Contributing, License, etc.)

    line 59
  11. Distinctive:

    Ask user which language(s) to translate to.

    line 65
  12. Distinctive:

    If current README is in Chinese (or any non-English), translate it to English first

    line 67
  13. Distinctive:

    After English version is established, add other language versions as requested

    line 68
  14. Distinctive:

    If user says "create bilingual README" without specifying:

    line 70
  15. Distinctive:

    Keep code blocks unchanged

    line 78
  16. Distinctive:

    Keep internal links (relative paths) as-is

    line 80
  17. Distinctive:

    Important: keep README.md as canonical English unless the user explicitly asks for another convention.

    line 85
  18. Distinctive:

    If the original README is non-English and user agrees, replace it with English README.md.

    line 93
  19. Distinctive:

    Update original README to include language switcher at the top:

    line 97
  20. Distinctive:

    Add below the title or badges, before the main content.

    line 103
  21. Distinctive:

    Add reciprocal link in the translated README:

    line 107

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Multi-Lang README

Overview

Create multilingual README files by translating an existing README while preserving Markdown structure, links, code blocks, and language-switch navigation. The workflow supports bilingual and multilingual README sets without rewriting unrelated project documentation.

When to Use

Use this skill when the user asks for:

  • Bilingual README creation (for example English + Chinese)
  • Multilingual README generation
  • Translating an existing README into one or more target languages
  • Standardized language-switch links across README files

Do not use

Do not use this skill for:

  • Translating arbitrary non-README documents
  • Rewriting product requirements or legal documents
  • Content generation tasks unrelated to README translation

Instructions

  1. Locate the source README file to translate (ask user if ambiguous).
  2. Confirm target language(s) and desired canonical README language.
  3. Translate content while preserving markdown, links, and code blocks.
  4. Write translated files using language suffix conventions.
  5. Add or update language-switch links at the top of each README.
  6. Verify filenames, link paths, and formatting before final output.

Supported Languages

CodeLanguage
enEnglish
deGerman
jaJapanese
koKorean
zh-CNChinese

Workflow

Step 1: Detect README

Find the source README:

  • Check root directory for README.md
  • If multiple README files exist, ask which file should be translated

Step 2: Read README Content

Read full markdown content, including:

  • Title
  • Badges
  • All sections (Features, Installation, Usage, Contributing, License, etc.)
  • Code blocks
  • Links

Step 3: Confirm Target Language

Ask user which language(s) to translate to. Default assumptions:

  • README.md should always be in English as the canonical version
  • If current README is in Chinese (or any non-English), translate it to English first
  • After English version is established, add other language versions as requested

If user says "create bilingual README" without specifying:

  • Translate existing README to English first (replace or create README.md)
  • Then add Chinese version (README.zh-CN.md)

Step 4: Translate with AI

Translate with these rules:

  • Preserve markdown formatting
  • Keep code blocks unchanged
  • Translate section titles to target language
  • Keep internal links (relative paths) as-is
  • For external links, use target language anchor text if appropriate

Step 5: Create Translated README

Important: keep README.md as canonical English unless the user explicitly asks for another convention.

  • English: README.md (create or replace with English version)
  • German: README.de.md
  • Japanese: README.ja.md
  • Korean: README.ko.md
  • Chinese: README.zh-CN.md

If the original README is non-English and user agrees, replace it with English README.md.

Step 6: Add Language Switcher

Update original README to include language switcher at the top:

**English** | [中文](README.zh-CN.md) | [Deutsch](README.de.md) | [日本語](README.ja.md) | [한국어](README.ko.md)

Add below the title or badges, before the main content.

Step 7: Update Translated README

Add reciprocal link in the translated README:

**[Original](README.md)** | [中文](README.zh-CN.md)

Language Code Reference

en    → no suffix (README.md)
de    → README.de.md
ja    → README.ja.md
ko    → README.ko.md
zh-CN → README.zh-CN.md

Common Triggers

  • "create bilingual README"
  • "create English and Chinese README"
  • "translate README to Japanese"
  • "add German version of README"
  • "add README.zh-CN.md"

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free