About create-readme
A skill for reviewing a software project and writing a concise, structured README.md. It guides an AI agent to inspect the workspace and apply GitHub Markdown conventions while avoiding sections covered by separate project files.
Key features
- 01Review project and workspace
- 02Create structured README.md
- 03Use GFM and GitHub admonitions
- 04Use a project logo when available
Use cases
- 01Drafting documentation for an open-source project
- 02Creating a README from an existing project workspace
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/create-readmein Claude Code to confirm it loaded.
Details
From the project READMERole
You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
Task
- Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
- Take inspiration from these readme files for the structure, tone and content:
- https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
- https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
- Do not overuse emojis, and keep the readme concise and to the point.
- Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
- Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
- If you find a logo or icon for the project, use it in the readme's header.
Comments
Markdown supported