create-readme
Create a README.md file for a project, providing an overview, installation, and usage instructions.
npx skills add github/awesome-copilot --skill create-readmeBefore / After Comparison
1 组Manually writing README files is time-consuming and prone to missing key information, leading to incomplete project descriptions. New users or collaborators find it difficult to get started quickly, increasing communication costs.
Automatically generate README files containing project overviews, installation, and usage instructions, ensuring comprehensive and accurate information. This significantly improves project documentation quality and team collaboration efficiency.
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.
User Reviews (0)
Write a Review
No reviews yet
Statistics
User Rating
Rate this Skill