Editor's Note
create-readme
Create a README.md file for the project
Install
npx skills add https://github.com/github/awesome-copilot --skill create-readmeSKILL.md
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.
Installs10.7K
GitHub Stars33.0k
LanguagePython
AddedJun 11, 2025
Categories
Related Git & Pull Requests Skills
View allfind-skills
vercel-labs/skills
1.1M18.6k1.1M
vercel-react-best-practices
vercel-labs/agent-skills
320.4K26.6k320.4K
frontend-design
anthropics/skills
299.9K134.5k299.9K
web-design-guidelines
vercel-labs/agent-skills
256.2K26.6k256.2K
remotion-best-practices
remotion-dev/skills
243.3K3.2k243.3K
agent-browser
vercel-labs/agent-browser
186.7K33.1k186.7K