agentleFS
Sign inStart free
mrchipsetmrchipset/zskills/skills/readme-i18n/SKILL.md

readme-i18n

Skill1 starsChanged 20 days agoMITView on GitHub

Create and maintain bilingual (English + Simplified Chinese) READMEs with a language switcher, and make Gitee auto-select the localized README while GitHub keeps showing English. Use when asked to add a Chinese README, add a README language toggle, explain how Gitee/GitHub choose localized READMEs, or fix README language selection.

14 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use git-doc-updater, git-precommit and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • u9401066Skill

    git-doc-updater

    Auto-check and update key documentation before Git commits to keep docs in sync with code. Triggers: docs, 文檔, 更新文檔, sync docs, release, 發布.

    Also in 5 projects that use this

  • u9401066Skill

    git-precommit

    Orchestrate pre-commit workflow including Memory Bank sync, README/CHANGELOG/ROADMAP updates. Triggers: GIT, gc, push, commit, 提交, 準備 commit, 要提交了, git commit, pre-commit, 推送.

    Also in 5 projects that use this

  • nilecuiSkill

    code-refactor

    Perform bulk code refactoring operations like renaming variables/functions across files, replacing patterns, and updating API calls. Use when users request renaming identifiers, replacing deprecated code patterns, updating method calls, or making consistent changes across multiple locations.

    Also in 5 projects that use this

  • GoogleSkill

    code-reviewer

    Also in 5 projects that use this

  • +8 more from u9401066

The file

We split this skill into the rules it gives an agent

11 rules. 0 are common, 7 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 7 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Gitee auto-selects by the viewer's browser language: Put README.md (English) and README.zh-CN.md (Chinese) in the repo root:

    line 10
  2. Very specific:

    Do not add README.en.md unless you explicitly want Gitee to prefer it for English browsers.

    line 25
  3. Distinctive:

    Place it immediately after the title / badges, near the top:

    line 30
  4. Very specific:

    Always renders README.md. README.zh-CN.md is not used as the repo landing page.

    line 55
  5. Distinctive:

    Do not claim GitHub can auto-switch.

    line 57
  6. Distinctive:

    Keep the same structure, headings, order, code blocks, tables and links.

    line 61
  7. Distinctive:

    Do not translate: commands, code identifiers, file paths, env vars, URLs, badge URLs, directory trees, or the ASCII architecture diagram.

    line 62
  8. Distinctive:

    Use plain, specific wording.

    line 66
  9. Distinctive:

    Keep the language switcher accurate in both files.

    line 67
  10. Distinctive:

    Update both files together when features change (do not let them drift).

    line 68
  11. Very specific:

    If you add README.en.md, keep it in sync with README.md (Gitee prefers .en.md for English browsers).

    line 84

“Common” is measured: kept by at least 6 in 10 of the 7 edited versions of this file we could read. “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

Bilingual README (English + Simplified Chinese)

Platform behavior (authoritative)

  • Gitee auto-selects by the viewer's browser language. Put README.md (English) and README.zh-CN.md (Chinese) in the repo root:
    • Chinese browser → README.zh-CN.md
    • English browser → README.md (fallback when no language-specific file matches)
  • GitHub does NOT auto-select. GitHub always renders README.md; there is no built-in multi-language README switching. Keep README.md in English and provide a link to the Chinese version.

Recommended file layout

README.md          # English: GitHub default + Gitee English fallback
README.zh-CN.md    # Simplified Chinese

Do not add README.en.md unless you explicitly want Gitee to prefer it for English browsers; README.md already serves as the English fallback.

Language switcher (required in both files)

Place it immediately after the title / badges, near the top:

  • README.md:
    **English** | [简体中文](README.zh-CN.md)
  • README.zh-CN.md:
    [English](README.md) | **简体中文**

Gitee localization rules (priority order)

  1. *.osc.md wins (e.g. README.osc.md).
  2. Language suffix:
    • Simplified Chinese: zh, cn, zh-cn, zh_cn
    • Traditional Chinese: zh-hk, zh-tw, zh-yue, zh_hk, zh_tw, zh_yue
    • English: en
  3. Otherwise extension priority (mdown, md, markdown, rst, …).

Matching is case-insensitive, so README.zh-CN.md matches zh-cn. The Gitee page footer also has a manual language switch.

GitHub behavior

  • Always renders README.md. README.zh-CN.md is not used as the repo landing page.
  • The switcher link is the only way for users to reach the Chinese version.
  • Do not claim GitHub can auto-switch; it cannot.

Translation rules

  • Keep the same structure, headings, order, code blocks, tables and links.
  • Do not translate: commands, code identifiers, file paths, env vars, URLs, badge URLs, directory trees, or the ASCII architecture diagram.
  • Translate prose and table descriptions. Keep proper nouns as-is (Tauri, Rust, WebView2, MediaPipe, aniface, three.js, GitHub, Gitee).
  • Use plain, specific wording; avoid marketing fluff and emojis.
  • Keep the language switcher accurate in both files.
  • Update both files together when features change (do not let them drift).

Verification

  • Both files start with a switcher that links to the other file.
  • README.zh-CN.md is valid UTF-8 and renders Chinese (no mojibake).
  • Push to the Gitee remote, then:
    • Chinese browser language → shows README.zh-CN.md
    • English browser language → shows README.md
  • On GitHub: README.md is shown; the “简体中文” link opens the Chinese README.

Gotchas

  • A single README.md cannot render differently per platform.
  • Gitee selects by the viewer's browser language (and footer toggle), not by repo language settings.
  • If you add README.en.md, keep it in sync with README.md (Gitee prefers .en.md for English browsers).
  • Remember to push to both remotes for Gitee to see the new files.

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