make-readme — Claude Code skill: what it does, how to install
make-readme inspects repository context, runs a brief questionnaire, and builds a complete README.md with status badges.
no license ★ 276 updated 2026-10-29
/plugin marketplace add gupsammy/Claudest
/plugin install claude-coding@ClaudestWhat make-readme does
The skill inspects local manifests before writing any docs. It looks for package.json, pyproject.toml, Cargo.toml, or go.mod to fill in default titles and primary runtimes. If it finds three or more plugin manifests in subfolders, it flags the repository as a plugin collection.
Next, the agent conducts a structured interview. You select the target architecture, runtime, license, and depth. Minimal builds skip straight to formatting. Standard and comprehensive setups trigger extra questions about screenshots, roadmap lists, and badge collections.
Existing files are safe because the skill warns before replacing any current README.md. It outputs ready-to-use markdown with custom header alignments and navigation links.
What it helps with
- generate structured
README.mdfiles from repository metadata - embed shields.io badges into documentation headers
- catalog plugins in monorepos with component directories
- scaffold contributing guidelines and configuration tables
Example prompts for the agent
- Create a README for my project
- Generate standard project documentation with badges
- Set up project docs for this plugin collection
How to install make-readme
1Plugin marketplace
/plugin marketplace add gupsammy/Claudest/plugin install claude-coding@ClaudestThis installs the whole claude-coding plugin with all its skills
2Skills CLI (Vercel)
npx skills add gupsammy/Claudest --skill make-readme -a claude-code3Manually: put the files in place
~/.claude/skills/make-readme/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/make-readme/
1Skills CLI (Vercel)
npx skills add gupsammy/Claudest --skill make-readme -a codex2Manually: put the files in place
.agents/skills/make-readme/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add gupsammy/Claudest --skill make-readme -a cursor2Manually: put the files in place
.cursor/skills/make-readme/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install gupsammy/Claudest plugins/claude-coding/skills/make-readme2Manually: put the files in place
.github/skills/make-readme/SKILL.md1Skills CLI (Vercel)
npx skills add gupsammy/Claudest --skill make-readme -a gemini-cli2Platform CLI
gemini skills install https://github.com/gupsammy/Claudest --path plugins/claude-coding/skills/make-readmeManually: put the files in place
.devin/skills/make-readme/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about make-readme
How to install make-readme in Claude Code?
Add the marketplace by running /plugin marketplace add gupsammy/Claudest, then install the package with /plugin install claude-coding@Claudest.
What does make-readme do?
It scans repository manifests, asks about sections and styles, and writes a complete README.md file.
Can make-readme overwrite my existing file?
It checks your directory first and prompts for confirmation if a README.md is already present.