readme-generator
A skill for writing a new README.md or reorganising an existing one so a newcomer sees the pitch, the install step and one common example before the details.
スキルの内容
A skill for writing a new README.md or reorganising an existing one so a newcomer sees the pitch, the install step and one common example before the details. In a Git repository it first syncs with origin, stashing tracked changes, and stops to ask if that fails. It then reads the manifest, licence, changelog, docs, tests and command-line definitions to collect facts with their source, backs up the old README, and writes the opening section followed by detail sections in a set order, keeping every original section. A self-check covers order, traced commands, working links and filler text. Missing facts become placeholders, and nothing is committed unless asked.
できること
- Write a README from facts in the repository
- Restructure an existing README without dropping sections
- Back up the previous README before writing
- Check commands and links in the result
概要
- 公開元
- Luong Nguyen
インストール
- すべてのクライアントに追加するには、次のコマンドを実行します:
npx skills@1.7.0 add https://github.com/luongnv89/skills --skill readme-generator
含まれるファイル
- references/anti-slop-rules.md
- references/final-report.md
- references/landing-section.md
- references/section-templates.md
- references/step-reports.md
MCPサーバーやスキルは、お使いのコンピューターでコードを実行したり、データを操作したりできます。インストールする前にソースを確認してください。
詳細
| 項目 | 内容 | 出典 |
|---|---|---|
| 種類 | スキル | |
| ツール | Documentation | |
| 公開元 | Luong Nguyen | 出典 |
| 公式かどうか | ドキュメントに記載なし | |
| APIキーまたはサインインが必要 | ドキュメントに記載なし | |
| スクリプトを含む | いいえ | 出典 |
| プラットフォーム | ドキュメントに記載なし | |
| AIクライアント | Claude Code, Cursor, Codex, Devin Desktop | 出典 |
| ライセンス | MIT | 出典 |
| 料金 | ドキュメントに記載なし | |
| 活動状況 | 最終コミット 2026年11月18日GitHubスター 147ダウンロード数のデータなし(npm・PyPIで未公開) | 出典 |
| リンク | リポジトリ Webサイト |
こちらにも掲載: Documentation
出典
- GitHubリポジトリgithub.com/luongnv89/skills · 根拠となる項目:AIクライアント, 活動状況, ライセンス2026年11月11日
- Webページraw.githubusercontent.com · 根拠となる項目:ライセンス, 公開元2026年11月19日
- スキルファイル(SKILL.md)github.com/luongnv89/skills2026年11月19日
- リポジトリ内のフォルダ(readme-generator)github.com/luongnv89/skills · 根拠となる項目:スクリプトを含む2026年11月19日