create-readme

Solid

Create a README.md file for the project

AI & Automation 34,887 stars 4287 forks Updated today MIT

Install

View on GitHub

Quality Score: 89/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
62
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

## 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 1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project. 2. 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 3. Do not overuse emojis, and keep the readme concise and to the point. 4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections. 5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate. 6. If you find a logo or icon for the project, use it in the readme's header.

Details

Author
github
Repository
github/awesome-copilot
Created
1 years ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category