Create Readme — Agent Skill by GitHub

From the author

Create a README.md file for the project

— the description by sinedied

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill acts as a senior software engineer to generate comprehensive and well-structured README.md files. It analyzes the project workspace to produce documentation that follows established open-source conventions, utilizing GitHub Flavored Markdown and admonition syntax to ensure clarity and readability.

What it does

Reviews project files to understand the codebase context
Generates a structured README.md document
Incorporates project logos or icons in the header if available
Applies GitHub Flavored Markdown for formatting
Uses GitHub admonition syntax for highlighting information

When to use it

When starting a new software project
When an existing project lacks documentation
When you need to standardize project information for contributors

Advantages

Ensures consistent documentation structure
Automates the creation of project overviews
Follows professional open-source documentation patterns

Usage examples

“Create a README.md for this project.”: The agent analyzes the current directory and generates a formatted README.md file containing project details and setup instructions.

Install

Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/github/create-readme/download

Unzip it into the cross-client skills folder of your project:

mkdir -p .agents/skills && unzip create-readme.zip -d .agents/skills

Documentation by sinedied

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:
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.

Files

ATTRIBUTION.mdAdded by AutoGineer1.1 KiB
LICENSELicence file added by AutoGineer1.0 KiB
SKILL.md1.3 KiB

Requirements and compatibility

Written for: GitHub Copilot

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Doc Coauthoring
AnthropicOfficial
Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
Link-onlyGitHub stars of the source repository188.6k
Markdown Mermaid Writing
K-Dense· Community
Generates scientific Markdown documentation and Mermaid structural diagrams for workflows, schemas, and relationships.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
Apache-2.0Low riskGitHub stars of the source repository56.4k
JSON Canvas
Steph Ango (Obsidian)· Community
Create and edit JSON Canvas files for visual organization and mapping.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository51k
Obsidian Markdown
Steph Ango (Obsidian)· Community
Generate and format Obsidian-specific Markdown syntax for notes, links, and embeds.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository51k
Faq
AnthropicOfficial
Generate a team-specific FAQ document to address recurring questions about AI tool usage and project conventions.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
Apache-2.0GitHub stars of the source repository46.3k
Hads
Seth Hobson· Community
A standardized Markdown format for technical documentation optimized for both human readability and AI model consumption.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository42.3k