create-readme
- Use it when:
- You want a README.md written for a project.
- It does:
- Reviews the whole project and workspace, takes structure and tone from four example READMEs it links to, and writes README.md.
- You get:
- A concise README.md in GitHub Flavored Markdown, with GitHub callouts where they fit and the project's logo in the header if it finds one.
- Leaves out:
- License, contributing and changelog sections, which belong in their own files, and heavy use of emoji.
TL;DR
A one-shot command. The agent plays a senior engineer experienced in open source: it reviews the entire project and workspace, then writes a comprehensive, well-structured README.md. For structure, tone and content it takes inspiration from four READMEs it names by URL, two from Azure-Samples serverless projects and two from sinedied's run-on-output and smoke repositories. The README should be appealing, informative and easy to read, yet concise, without overused emoji. It uses GitHub Flavored Markdown, with GitHub's admonition syntax (callout blocks such as a note or a warning) where appropriate, and puts the project's logo or icon in the header if it finds one. Sections such as LICENSE, CONTRIBUTING and CHANGELOG are left out, since dedicated files cover them.
Summarizes the skill at 797337f.
npx skills add https://github.com/github/awesome-copilot --skill create-readme skills.sh pageSource on GitHubAll skills from github/awesome-copilot
- Total Downloads
- 19,400 on skills.sh, Nov 9, 2026
- Repo stars
- 40,943 github/awesome-copilot
- First seen
- Feb 25, 2026 on skills.sh
Weekly values
| Week to | Installs |
|---|---|
| Sep 21 | 176 |
| Sep 28 | 175 |
| Oct 5 | 163 |
| Oct 12 | 153 |
| Oct 19 | 199 |
| Oct 26 | 151 |
| Nov 2 | 178 |
| Nov 9 | 150 |
| Category |
Articles, docs, internal comms, research write-ups and prose that doesn't read as generated. |
|---|---|
| Type |
A one-shot action you invoke by name, such as turning the conversation into a PRD. |
| Effect |
Its own steps create or change files, git state or local tools. |
| Needs |
Instructions only. Works in any agent that supports skills. |
| Publisher |
A verified publisher on skills.sh, or the company or maintainer behind the product the skill operates. |
| Topics |
SKILL.md
From github/awesome-copilot at 797337f. Checked daily, last changed Nov 6, 2026.
Frontmatter
name: create-readme
description: 'Create a README.md file for the project'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.