Create Readme
github/awesome-copilotOfficial
The create-readme skill generates a comprehensive README.md file for software projects by analyzing the entire codebase and applying best practices from established open source projects. It's designed for developers who need professional, well-structured documentation that clearly communicates their project's purpose, usage, and value. The skill solves the problem of creating appealing and informative README files without marketing language, following specific formatting standards and excluding redundant sections covered elsewhere in the repository.
- installs
- 19.1K
- GitHub stars
- 40.5K
- last updated
- Aug 21, 2026
Install
$ npx -y skills add github/awesome-copilot --skill create-readme --agent claude-codeInstalls into .claude/skills of the current project.
Files
Role
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.
Sponsors
Details
- Repository
- github.com/github/awesome-copilot
- Categories
- Git & Pull Requests, Documentation, AI & Agent Building
