中文项目或面向国内用户时,一份中文 README 能显著降低上手门槛。
纯中文 README
结构与国际惯例一致,只是文案用中文。注意代码块、命令保持原样,不要翻译。
双语 README
国际开源项目常见做法:
# 项目名称 [English](README.md) | [中文](README.zh-CN.md)
在顶部放语言切换链接,分别维护两份文件。工具的「语言」选项可直接切到中文模板。
双语小贴士
- 术语首次出现可中英并列,如「特性(Features)」。
- 保持两份结构同步,避免一处更新另一处遗忘。
需要英文骨架看《GitHub README 模板》。
立即使用 AI README 生成器 →