CustomAgent.app
Skill
documentation
✓ Verified
⭐ Featured
Free

README Generator

Generate comprehensive, well-structured README files from project context, dependencies, and code.

4.8(201 reviews)
89,300 installs
by GitHub

About

Scans your project structure, package manifests, and source files to produce a polished README with all the essential sections: intro, badges, install, usage, configuration, contributing, and license. Uses GitHub Flavored Markdown and adapts to the project type (library, CLI, web app, monorepo).

Tags

readmedocsmarkdownonboarding

Skill Instructions Preview

# Create README

Generate a polished README.md for the current project.

## Process
1. Detect project type (library, CLI, web app, service, monorepo)
2. Read package.json / pyproject.toml / Cargo.toml / go.mod for metadata
3. Identify entry points and main features
4. Check for existing badges, CI configs, license
5. Generate structured sections:
   - Title + tagline
   - Badges (build, version, license)
   - Description (what + why)
   - Quickstart
   - Installation
   - Usage examples
   - Configuration
   - API / Commands reference
   - Contributing
   - License

## Format Rules
- GitHub Flavored Markdown
- Code blocks with language hints
- Minimal emoji unless project style requires them
- Links absolute when crossing repo boundaries
- Keep examples copy-paste runnable

Related Skills

Skill
documentation
FREE

Auto Documentation Writer

Generate inline docstrings, JSDoc/TSDoc comments, and module-level documentation from code semantics.

docsjsdocdocstrings
G
GitHub
4.6(124)
46k
★2.8k
Skill
development
FREE

Code Exemplars Blueprint Generator

Generate a project-specific exemplars file showing the right way to do common patterns in your codebase.

conventionspatternsonboarding
G
GitHub
4.8(58)
21k
★1.2k
SkillNEW⭐
ai
FREE

AGENTS.md Creator

Generate an AGENTS.md file giving AI assistants the context they need to work effectively in your repo.

agentscontextonboarding
C
Community
4.9(52)
19k
★1.4k
Install
# Add as Claude Code slash command:
curl -fsSL "https://raw.githubusercontent.com/github/awesome-copilot/main/skills/create-readme/SKILL.md" \
  -o ~/.claude/commands/create-readme.md
View source on GitHub →

Compatible with

claude codegithub copilotcursor

Trigger phrase

/create-readme
G

GitHub

@github

View on GitHub