Create Readme
Generate a polished, GitHub-flavored README.md for an open-source or side project by having the agent audit the workspace and mirror proven sample structures.
Overview
Create README is an agent skill for the Build phase that drafts a comprehensive README.md from your project workspace using senior-engineer tone and GitHub Flavored Markdown.
Install
npx skills add https://github.com/github/awesome-copilot --skill create-readmeWhat is this skill?
- Full-workspace review pass before drafting README structure and copy
- Tone and structure inspired by Azure Samples and run-on-output style reference READMEs
- GitHub Flavored Markdown with admonition blocks where they add clarity
- Explicitly skips LICENSE, CONTRIBUTING, and CHANGELOG sections that belong in dedicated files
- Optional project logo or icon in the header when assets exist in the repo
- References four public sample README URLs for structure and tone
Adoption & trust: 13.7k installs on skills.sh; 34.6k GitHub stars; 2/3 security scanners passed (skills.sh audits).
What problem does it solve?
Your repo works but the GitHub landing page still looks empty, outdated, or unlike the polished samples you want collaborators and users to trust.
Who is it for?
Solo OSS maintainers and indie hackers who need a credible README after the code exists and before sharing the repo widely.
Skip if: Monorepos that require per-package README assembly from doc.json or MoonBit doctest layouts—use a construction pipeline skill instead.
When should I use this skill?
Create a README.md file for the project.
What do I get? / Deliverables
You get a concise, well-structured README.md with sensible sections, GFM formatting, and optional branding header—without boilerplate files the skill is told to skip.
- README.md at repository root (or path you specify)
- GFM-formatted overview with usage-oriented sections
Recommended Skills
Journey fit
README creation is a Build/docs artifact that ships with the repo before launch and distribution work. Docs subphase is the canonical home for repository-facing prose installers and visitors read first on GitHub.
How it compares
One-shot narrative README authoring, not an automated doc-comment or template assembly toolchain.
Common Questions / FAQ
Who is create-readme for?
Developers shipping pet projects, samples, or small products who want GitHub-native README quality without hand-copying structure from favorite open-source repos.
When should I use create-readme?
During Build/docs when initializing public documentation, right before Launch distribution when the repo URL will be shared, or after a major feature pass when the old README no longer matches the code.
Is create-readme safe to install?
It instructs the agent to read your workspace and write markdown; confirm scope in your agent settings and check the Security Audits panel on this Prism page.
SKILL.md
READMESKILL.md - Create Readme
## 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.