メニュー
Generate a README.md for the current project by analyzing the codebase structure, package files, and existing documentation. Use when asked to write a README, create documentation, or document the project.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
Explains code in plain language for someone unfamiliar with the programming language. Use when asked to explain code, walk through logic, describe what a function does, or when the user says "explain this" or "walk me through this".
Summarizes uncommitted git changes in a concise machine-readable format. Use in CI pipelines, scripts, or headless invocations where the output will be piped or captured.
Explains what a skill is and demonstrates that skills are working. Use when testing skills, when asked about skills, or when asked to demonstrate how skills work.
Demonstrates the personal scope for Claude Code skills. Use when testing personal-scoped skills or when the user wants to understand the difference between personal and project skill scopes.
Lists the conventions for this project and demonstrates the project scope for Claude Code skills. Use when asked about project conventions, code style, or as a demonstration of project-scoped skills.
Draft a CHANGELOG.md entry for the current changes in Keep a Changelog format. Use when releasing, tagging a version, or updating CHANGELOG.md.
| title | readme-generator |
| name | readme-generator |
| description | Generate a README.md for the current project by analyzing the codebase structure, package files, and existing documentation. Use when asked to write a README, create documentation, or document the project. |
| allowed-tools | Read Bash(ls *) Bash(find *) Bash(cat package.json) Bash(cat pyproject.toml) Bash(cat Cargo.toml) |
Check for language and framework indicators in this order:
package.json — Node.js / JavaScript / TypeScript projectpyproject.toml or setup.py — Python projectgo.mod — Go projectCargo.toml — Rust projectbuild.gradle or pom.xml — Java / Kotlin project*.gemspec or Gemfile — Ruby projectRead whichever file is found to extract the project name, version, description, and dependencies.
Based on the project type, read the main entry point:
main field in package.json, or look for src/index.ts, src/index.js, index.ts, index.js__main__.py, the module directory, or the entry point in pyproject.tomlmain.go or cmd/<name>/main.gosrc/main.rs or src/lib.rsRead the first 80 lines to understand what the project does.
Run ls -1 at the project root and at the src/ (or equivalent) directory if it exists. Note top-level directories that give structure clues (cli/, api/, lib/, tests/, docs/, examples/).
Produce a README.md with the following sections in this order. Include a section only if there is real content for it — do not leave placeholder text in any section except Badges.
# Project Name
One sentence describing what the project does and who it is for.
## Badges
<!-- Add badges here: build status, coverage, version, license -->
## Installation
Commands to install the project. Use the package manager detected in step 1.
## Usage
The minimal example to get something working. Show a command or code snippet.
If the project has a CLI, show the most common command.
If it is a library, show an import and a basic function call.
## Configuration
If the project has configuration options (environment variables, config files, flags),
list the important ones with their defaults and descriptions.
## Contributing
Brief instructions: how to set up a dev environment, how to run tests, how to submit a change.
## License
State the license. Read the LICENSE file if present to confirm.
After writing the README, tell the user which sections have placeholder content (Badges) and which sections they should review for accuracy (Usage examples especially benefit from human review).