Menu

Individual skill

readme-generator

0upvotes

Write or overhaul a project README from the repository itself - audience-first structure, a quickstart where every command is verified by running it or tracing it to CI, a configuration table built from the env vars the code reads, real troubleshooting, and contributing and license sections. Use when someone asks "write a README for this repo", "our README is out of date", "improve the getting-started section", or "new contributors can't get this running". Do NOT use for end-user help-center articles - use help-documentation instead - or for on-call procedures - use runbook-writer instead.

skills/readme-generator/SKILL.md

Read pinned source

Source commit 97a13607d669157a4a16d5ba79b77f208319f7b9

What was checked

Matches the observed repository HEAD
Yes
Scanner rules are current
No
Repository scan complete
No
Skill scan complete
No
Observed behavior
Not checked yet
Last checked
Nov 6, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings)
24
Repository last updated
Oct 13, 2026
License
MIT

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files
Read excerpt

# README Generator

A README's main job is to get a stranger from "what is this?" to a working result before they give up. The costly mistake this skill prevents is the plausible README written from memory or a template: its quickstart says `npm install && npm start` when the repo uses pnpm, needs Node 20, and will not boot without three unmentioned environment variables. Every newcomer pays the same 30 minutes or leaves. A first command that fails teaches readers not to trust the rest.

## Operating procedure

### Step 1: Identify the audience and the job

Decide who lands on this README and what they came to do. That choice drives everything else:

- **Library or package users** want install, a minimal usage snippet, and a link to the API reference.
- **Application operators** want to run, deploy, and configure it.
- **Contributors** want to clone, build, test, and understand the layout.