Creates a comprehensive, professional README.md for a project. Use when a project has no README, when the existing README is outdated, or when asked to generate project documentation. Follows OSS conventions with GFM formatting, project logo detection, and concise writing style.
Installation
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Creates a comprehensive, professional README.md for a project. Use when a project has no README, when the existing README is outdated, or when asked to generate project documentation. Follows OSS conventions with GFM formatting, project logo detection, and concise writing style.
Workflow
Review the entire project and workspace, then create a well-structured README.md.
Take inspiration from these readme files for structure, tone, and content: