Create Readme
- 16.2k installs
- 37.1k repo stars
- Updated July 28, 2026
- github/awesome-copilot
Create README is a skill for authoring compelling, well-structured README.md files using GitHub Flavored Markdown and best practices from successful projects.
About
Create README guides developers in writing comprehensive, well-structured README.md files for open source projects. It emphasizes thorough project review before writing, uses GitHub Flavored Markdown with admonition syntax, and maintains concise, appealing documentation without overusing emojis. Use this skill when onboarding open source projects, establishing documentation standards, or generating initial README structure. Excludes LICENSE/CONTRIBUTING/CHANGELOG sections which belong in dedicated files, following best practices from successful open source projects.
- Comprehensive README structure from full project review
- GitHub Flavored Markdown (GFM) with admonition syntax
- Concise, appeal-driven format without LICENSE/CONTRIBUTING sections
Create Readme by the numbers
- 16,218 all-time installs (skills.sh)
- +393 installs in the week ending Jul 28, 2026 (Skillselion tracking)
- Ranked #26 of 1,901 Documentation skills by installs in the Skillselion catalog
- Security screen: MEDIUM risk (skills.sh audit)
- Data as of Jul 28, 2026 (Skillselion catalog sync)
create-readme capabilities & compatibility
- Use cases
- documentation
- Platforms
- macOS · Windows · Linux
- Runs
- Runs locally
- Pricing
- Free
npx skills add https://github.com/github/awesome-copilot --skill create-readmeAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 16.2k |
|---|---|
| repo stars | ★ 37.1k |
| Security audit | 2 / 3 scanners passed |
| Last updated | July 28, 2026 |
| Repository | github/awesome-copilot ↗ |
How do you write a professional README from an existing codebase?
Create README guides developers in writing comprehensive, well-structured README.md files for open source projects. It emphasizes thorough project review before writing, uses GitHub Flavored Markdown
Who is it for?
Developers with a working codebase who need a polished GitHub README before open-sourcing or onboarding contributors.
Skip if: Teams needing API reference docs, architecture decision records, or README updates when only a one-line change is required.
When should I use this skill?
User asks to create or regenerate README.md, document project structure and usage, or prepare a repo for open source.
What you get
README.md with project overview, structure, usage instructions, and value proposition aligned to the workspace.
- complete readme.md file
- structured markdown
- logo integration
Files
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.
Related skills
Lark MarkdownInstantly turn any markdown file into clean, formatted Lark/Figma-compatible documents without manual reformatting.402k
Lark DocCreate, read, update, summarize, rewrite and manage Feishu/Lark cloud documents directly from agent workflows.377k15.7kLark WikiCreate, organize, query, and manage documents, spaces, and members inside Lark (Feishu) knowledge bases directly from AI agent workflows.374k15.7k
Opensource Guide CoachGet expert, attribution-safe guidance on launching and sustaining an open-source project.270k72Readme I18nMaintain consistent, updatable language selector blocks across every README variant in a multilingual repository.270k72
CavemanCompress SPEC.md files and any spec-adjacent prose into a token-efficient format that preserves precision while slashing context usage.259k1.1kForks & variants (1)
Create Readme has 1 known copy in the catalog totaling 218 installs. They canonicalize to this original listing.
- ilteoood - 218 installs
How it compares
Choose create-readme for full-repo README drafts; use narrower doc skills when you only need API or changelog files.
FAQ
What should NOT be in a README?
LICENSE, CONTRIBUTING, CHANGELOG sections. These belong in dedicated files. README stays concise and focused on getting started.
How much emoji should I use?
Avoid overusing emojis. Keep the README professional and readable. Use them sparingly for visual breaks, not heavy emoji decoration.
Is Create Readme safe to install?
skills.sh reports 2 of 3 security scanners passed. Review the Security Audits panel on this page before installing in production.