Skip to main content
affpapa.org
RU EN
skill GitHub Copilot official · GitHub

create-readme — GitHub Copilot skill: what it does, install

This skill reviews a project and creates a structured README.md. Use it when the repository needs clear documentation based on its actual files and code.

Install into GitHub Copilot · Skills CLI (Vercel) All methods and platforms ↓ 
npx skills add github/awesome-copilot --skill create-readme
Open on GitHub

What create-readme does

create-readme reviews the full project and workspace, then creates a README.md. It organizes the document with GitHub Flavored Markdown and uses GitHub admonition syntax where it fits. When the project contains a logo or icon, the skill can place it in the README header.

The generated file leaves out LICENSE, CONTRIBUTING, and CHANGELOG sections because those have dedicated files. The instructions also keep emoji use limited and the README concise. Install it when documentation should reflect the repository itself; it is a poor fit when you need a tightly controlled manual template.

What it helps with

  • create a README.md from the project contents
  • document a repository with GFM formatting
  • add a discovered project logo or icon to the README header
  • leave LICENSE and CHANGELOG sections out of the README

Example prompts for the agent

  • Review the whole workspace and create a README.md for this project.
  • Update README.md from the current codebase, using GFM and GitHub admonitions where appropriate.
  • Create a concise README.md without LICENSE, CONTRIBUTING, or CHANGELOG sections.

How to install create-readme

1Skills CLI (Vercel)

npx skills add github/awesome-copilot --skill create-readme

2GitHub CLI

gh skill install github/awesome-copilot create-readme

3Manually: put the files in place

.github/skills/create-readme/SKILL.md

From the same set554

The whole set →
git-commit official github This skill reviews Git changes, stages related files, and creates Conventional Commits. Use it when you want an agent to make one commit or split work into separate commits. GitHub Copilot 47,165installs excalidraw-diagram-generator official github Turn a plain-language description into an Excalidraw diagram. Useful for mapping processes, system structure, and relationships between entities. GitHub Copilot 31,639installs multi-stage-dockerfile official github This skill guides GitHub Copilot in writing multi-stage Dockerfiles for different languages and frameworks. Use it when the final runtime image should contain fewer build dependencies. GitHub Copilot 29,688installs documentation-writer official github Skill that turns the agent into a technical writer following the Diátaxis framework: tutorials, how-to guides, reference, and explanation. Proposes structure before writing. GitHub Copilot 27,757installs prd official github Turns a feature idea into a structured PRD with user stories, technical requirements, and risks. Use it when planning a software feature or an AI-powered one. GitHub Copilot 24,035installs refactor official github This skill reshapes existing code without changing its external behavior. Use it for gradual cleanup of large functions, duplication, weak types, and code smells. GitHub Copilot 22,321installs java-springboot official github Gives GitHub Copilot Spring Boot development practices, from project layout to tests and security. Use it when writing or reviewing Java application code. GitHub Copilot 21,272installs playwright-generate-test official github Generates a Playwright test from a scenario through Playwright MCP. Use it when the browser flow should be completed before test code is written. GitHub Copilot 18,162installs

Similar

bmad-review bmad-code-org Runs a diff, pull request or document through one or more review lenses and reports triaged findings. Only fires when you actually ask for a review. Claude Code CX Codex Cursor +1 11,400installs bmad-ux bmad-code-org Captures UX vision into DESIGN.md and EXPERIENCE.md documents. It structures visual identity and interaction logic without imposing arbitrary choices. Claude Code CX Codex Cursor +1 11,400installs understand Egonex-AI Analyzes a codebase and builds an interactive knowledge graph of its architecture, components, and relationships. Use it to explore an existing project. Claude Code CX Codex Cursor +1 5,200installs bmad-project-context bmad-code-org Builds, audits, and maintains the verified agent instructions block inside AGENTS.md. It keeps repository rules accurate and records past agent mistakes as explicit pitfalls. Claude Code CX Codex Cursor +1 11,300installs bmad-prfaq bmad-code-org This skill tests a product concept with a Working Backwards PRFAQ, moving from a finished-product press release to hard customer and stakeholder questions. Claude Code CX Codex Cursor +1 11,200installs bmad-deep-recon bmad-code-org A research skill that drafts a deep-research prompt, processes a finished report, or runs the research itself on a topic or your repo. Claude Code CX Codex Cursor +1 11,200installs grill-with-docs Matt Pocock This skill interviews you about a plan or design and creates ADRs and a glossary along the way. Use it when decisions need sharper definition. Claude Code 1,219,756installs skill-creator official anthropics Creates and refines skills, then tests them with prompts, evaluations, and performance checks. Claude Code Claude.ai 414,180installs

Questions about create-readme

How do I install create-readme in GitHub Copilot?

Run npx skills add github/awesome-copilot --skill create-readme, then use .github/skills/create-readme/SKILL.md.

What does create-readme do?

It reviews the project and workspace, then creates a structured README.md in GitHub Flavored Markdown. It can also use a project logo or icon in the README header.

Which sections does create-readme leave out?

It leaves out LICENSE, CONTRIBUTING, and CHANGELOG sections. These are expected to live in dedicated files.

Source text

SKILL.md · MIT 
---
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

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.

© github · MIT · github/awesome-copilot

See also

Project sponsors

Companies that keep this analytics open
Gold sponsor
Nutra.Club

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor