readme

Generate structured README.md files from a project name and description.

2|Updated Feb 18, 2015

Search Tags:#automation #templates #documentation #markdown #readme #project-setup

One-click install

npx skills add https://github.com/markahesketh/dotfiles --skill readme

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: readme
Source: https://github.com/markahesketh/dotfiles/tree/main/home/.claude/skills/readme
Command: npx skills add https://github.com/markahesketh/dotfiles --skill readme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of clear, concise README.md files for projects, saving time and ensuring consistent documentation across teams.

Core Features & Use Cases

Structured sections: Name, Description, Installation, Usage, License, plus optional badges, visuals, and contributors.
Guided templates: Produces polished README content aligned with project docs.
Use Case: You need a README for a new project or want to standardize documentation across multiple repositories.

Quick Start

Provide a project name and a short description, and I will generate a ready-to-use README.md with a clean structure and example usage.