mcpField
Z
zr-readme

zr-readme

github.com/zenon-red文档处理265 次安装22 周前更新
代码仓库

关于 zr-readme

zr-readme 是用于生成符合 zenon-red 仓库结构与风格的 README 文件的技能，涵盖仓库信息收集、章节顺序、格式规则和模板核对。

主要功能

  1. 01遵循规定的 README 章节顺序
  2. 02使用 README 模板
  3. 03规定标题和导航格式
  4. 04指定代码块规范
  5. 05核对徽章样式与章节顺序

适用场景

  1. 01为 zenon-red 仓库起草 README
  2. 02统一多个仓库的 README 章节
  3. 03按仓库规范检查 README 格式

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/zenon-red/skills --skill zr-readme

安装后在 Claude Code 中输入/zr-readme确认已加载。

附带文件assets/readme-template.md

详细介绍

Zenon Red README 创建

生成与 zenon-red 仓库结构和风格完全一致的 README 文件。

模板

以 assets/readme-template.md 中的模板为基本结构。

章节顺序（必需）

每个 README 都必须遵循以下顺序：

  1. 页眉 - 居中的 <div>，包含 Logo 图片、# 标题 和标语段落
  2. Why - 说明用途和背景
  3. 导航 - 居中的 <p>，包含指向重要文档的链接
  4. 用法 - 安装、要求和示例
  5. 贡献 - 引用 CONTRIBUTING.md
  6. 许可证 - 引用 LICENSE 文件

格式规则

页眉部分
<div align="center">
<img width="128px" alt="{name} logo" src="./.github/{name}.png">

# {Name}

<p align="center">
{tagline line 1}.<br/>
{tagline line 2}.<br/>
Built by Aliens.
</p>

</div>
  • Logo：宽度为 128px，PNG 文件，存放在 .github/ 文件夹中
  • 例外：对于已将 Logo 存放在根目录的特殊仓库（例如 zenon-red/.github），请遵循现有的仓库约定。
  • 标题：使用普通的 # 标题，不要使用 Markdown 链接
  • 标语：2-3 行，始终以 "Built by Aliens." 结尾
要求徽章

使用居中的 <h3 align="center">REQUIREMENTS</h3> 和 <p align="center"> 包裹：

<h3 align="center">REQUIREMENTS</h3>

<p align="center">
  <a href="https://nodejs.org/" target="_blank">
    <img src="https://img.shields.io/badge/Node.js-%3E%3D22.0.0-339933?logo=nodedotjs&logoColor=white&style=for-the-badge" alt="Node.js">
  </a>
</p>

徽章格式：https://img.shields.io/badge/{Label}-{Version}-{Color}?logo={icon}&logoColor=white&style=for-the-badge

导航链接

使用带间隔点分隔符的居中段落：

<p align="center">
  <a href="./docs/getting-started.md">Getting Started</a> ·
  <a href="./docs/commands.md">Commands</a> ·
  <a href="./docs/other.md">Other</a>
</p>
代码块

始终使用 bash 语言标签。命令输出示例使用 $ 前缀：

```bash
$ probe task list
tasks[5]{id,title,status}:
  "1","Example task",OPEN
```
小节

在 ## Usage 下使用 ### 作为小节标题。常见小节包括：

  • 安装（含 #### Node Package Manager、#### GitHub Releases）
  • 入门步骤（编号列表）
  • 查询/用法示例
  • 下一步（链接至 SKILL.md）
贡献部分

引用 Nexus 的标准文本：

## Contributing

This project is intended to be maintained autonomously by agents in the future. Humans can contribute by routing changes through their agents via [Nexus](https://github.com/zenon-red/nexus). See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
许可证部分
## License

[MIT](./LICENSE)

流程

  1. 收集仓库信息：名称、描述、技术栈、主要功能
  2. 如果不存在预期的 Logo 路径（通常是 .github/{name}.png），则生成 Logo 占位说明
  3. 按照模板结构编写每个部分
  4. 确保所有徽章都使用 style=for-the-badge
  5. 验证章节顺序完全一致

徽章颜色参考

  • Node.js：339933（绿色）
  • Rust：000000（黑色）
  • Python：3776AB（蓝色）
  • TypeScript：3178C6（蓝色）
  • Go：00ADD8（青色）

评论

支持 Markdown