write-root-readme

编写根目录 README

指南

• 要更新的文件：
  • 仓库根目录中的 README.md
• 阅读 example-readme.md，了解参考结构和风格。
• 鼓励添加徽章。可参考示例 README 中的实用徽章。
  • 适用时，优先使用示例 README 中的徽章。
  • 优先使用包含实时数据的徽章，而非静态徽章。
• 鼓励在标题中使用表情符号。
• 鼓励添加 Hero 区域。严格遵循示例 README 中的格式。
  • 使用 GitHub Socialify 生成项目图片。生成的图片已包含 Logo、标题、描述，以及星标、分支、问题和拉取请求徽章。
  • 如有文档，请添加文档链接。
  • 鼓励在 Hero 区域添加徽章。徽章数量最多为 8 个。
  • Hero 区域中的链接最多为 4 个。
  • 在 Hero 区域后添加分隔线。
• 鼓励添加许可证部分。严格遵循示例 README 中的格式。
• 不要在 README 中使用相对链接。
• 优先进行大幅、全面的重写，而非细微或渐进式修改。
• README 应保持简洁。

验证

• 运行 rumdl fmt .。将其发现的问题视为参考建议，而非硬性约束。
• 完成前，针对实际仓库文件抽查命令、链接和工具名称。