Back to Details

write-root-readme

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Write Root README

撰写根目录README

Guidelines

指南

  • files to update: 
    • README.md
      in the repo root
  • Read example-readme.md for a reference structure and style.
  • Badges are encouraged. See example README for useful badges.
    • Prefer badges in example README when applicable.
    • Prefer badges with live data over static badges.
  • Emojis are encouraged in headers.
  • Hero section is encouraged. Follow the format in example README strictly.
    • Use GitHub Socialify to generate a project image. The generated image already includes logo, title, description, badges for stars, forks, issues, pulls.
    • Include link to docs if exists.
    • Badges in hero section are encouraged. Limit hero section to 8 badges.
    • Limit hero section to 4 links.
    • Include a rule after hero section.
  • License section is encouraged. Follow the format in example README strictly.
  • DO NOT use relative links in README.
  • Favor bold, comprehensive rewrites over minor or incremental edits.
  • Keep README concise.
  • 需要更新的文件：
    • 仓库根目录下的
      README.md
  • 参考example-readme.md的结构和风格。
  • 鼓励使用徽章。参考示例README中的实用徽章。
    • 适用时优先使用示例README中的徽章。
    • 优先选择带有实时数据的徽章，而非静态徽章。
  • 鼓励在标题中使用表情符号。
  • 鼓励添加Hero区域。严格遵循示例README中的格式。
    • 使用GitHub Socialify生成项目图片。生成的图片已包含logo、标题、描述以及stars、forks、issues、pulls的徽章。
    • 如果存在文档链接，请包含在内。
    • 鼓励在Hero区域添加徽章。Hero区域的徽章数量限制为8个。
    • Hero区域的链接数量限制为4个。
    • Hero区域后需添加一条分隔线。
  • 鼓励添加许可证章节。严格遵循示例README中的格式。
  • 请勿在README中使用相对链接。
  • 优先选择全面的重写，而非微小或增量式的编辑。
  • 保持README简洁。

Validation

验证

  • Run 
    rumdl fmt .
    . Treat its findings as weak hints, not strong constraints.
  • Spot-check commands, links, and tool names against the actual repo files before finishing.
  • 运行
    rumdl fmt .
    。将其结果视为弱提示，而非强制约束。
  • 在完成前，对照实际仓库文件抽查命令、链接和工具名称。