write-root-readme

ルート README を作成する

ガイドライン

• 更新するファイル：
  • リポジトリのルートにある README.md
• 参考となる構成とスタイルについては、example-readme.md を確認してください。
• バッジの使用を推奨します。参考になるバッジについては、サンプル README を参照してください。
  • 該当する場合は、サンプル README にあるバッジを優先してください。
  • 静的なバッジより、ライブデータを表示するバッジを優先してください。
• 見出しでの絵文字の使用を推奨します。
• ヒーローセクションの使用を推奨します。サンプル README の形式に厳密に従ってください。
  • GitHub Socialify を使ってプロジェクト画像を生成してください。生成された画像には、ロゴ、タイトル、説明、スター数・フォーク数・Issue 数・プルリクエスト数のバッジがすでに含まれています。
  • ドキュメントがある場合は、そのリンクを含めてください。
  • ヒーローセクションでのバッジの使用を推奨します。バッジは 8 個までにしてください。
  • ヒーローセクションのリンクは 4 個までにしてください。
  • ヒーローセクションの後に区切り線を入れてください。
• ライセンスセクションの使用を推奨します。サンプル README の形式に厳密に従ってください。
• README で相対リンクを使用しないでください。
• 細かな変更や段階的な編集ではなく、大幅で包括的な書き直しを優先してください。
• README は簡潔にしてください。

検証

• rumdl fmt . を実行してください。検出された問題は、厳格な制約ではなく参考情報として扱ってください。
• 作業を終える前に、コマンド、リンク、ツール名を実際のリポジトリ内のファイルと照合して確認してください。