mcpField
Z
zr-readme

zr-readme

github.com/zenon-redドキュメント265 回インストール22 週間前に更新
リポジトリ

zr-readme について

zr-readmeは、zenon-redリポジトリの構成とスタイルに沿ったREADMEを作成するスキルです。リポジトリ情報の収集、セクション順、書式、テンプレートとの照合を扱います。

主な機能

  1. 01指定されたREADMEのセクション順
  2. 02READMEテンプレートの使用
  3. 03ヘッダーとナビゲーションの書式指定
  4. 04コードブロックの規則
  5. 05バッジ形式とセクション順の確認

活用シーン

  1. 01zenon-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. ヘッダー - ロゴ画像、# Title、タグラインの段落を含む、中央揃えの <div>
  2. 理由 - 目的と背景を説明します
  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>
  • ロゴ：幅 128px、.github/ フォルダー内の PNG
  • 例外：ロゴをルートに配置する既存の規約がある特別なリポジトリ（例：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. 想定されるロゴのパスが存在しない場合は、ロゴのプレースホルダーメモを生成します（通常は .github/{name}.png）
  3. テンプレートの構造に従って各セクションを記述します
  4. すべてのバッジで style=for-the-badge が使用されていることを確認します
  5. セクションの順序が厳密に一致していることを確認します

バッジの色の参照

  • Node.js：339933（緑）
  • Rust：000000（黒）
  • Python：3776AB（青）
  • TypeScript：3178C6（青）
  • Go：00ADD8（シアン）

コメント

Markdown 対応