# make-readme

make-readme inspects repository context, runs a brief questionnaire, and builds a complete README.md with status badges.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 276 repo stars
- Author: Samarth Gupta
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/gupsammy/Claudest/tree/HEAD/plugins/claude-coding/skills/make-readme/SKILL.md
- Updated: 2026-10-29
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/make-readme

## What it 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.

## Install

### Claude Code (native platform)

1. **Plugin marketplace**
In the agent chat (not a shell):
```text
/plugin marketplace add gupsammy/Claudest
```
In the agent chat (not a shell):
```text
/plugin install claude-coding@Claudest
```
This installs the whole claude-coding plugin with all its skills

2. **Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill make-readme -a claude-code
```

3. **Manually: put the files in place**
- File: `~/.claude/skills/make-readme/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/make-readme/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill make-readme -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/make-readme/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill make-readme -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/make-readme/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install gupsammy/Claudest plugins/claude-coding/skills/make-readme
```

2. **Manually: put the files in place**
- File: `.github/skills/make-readme/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill make-readme -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/gupsammy/Claudest --path plugins/claude-coding/skills/make-readme
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/make-readme/SKILL.md` — The legacy .windsurf/skills/ path still works

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/gupsammy/Claudest/tree/HEAD/plugins/claude-coding/skills/make-readme/SKILL.md

## When to use it
- generate structured `README.md` files 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
- Create a README for my project
- Generate standard project documentation with badges
- Set up project docs for this plugin collection

## Similar
- [readme-optimization](https://affpapa.org/en/nevibecode/skills/readme-optimization.md) — skill · 13600 installs
- [readme-blueprint-generator](https://affpapa.org/en/nevibecode/skills/readme-blueprint-generator.md) — skill · 9662 installs
- [indexion-readme](https://affpapa.org/en/nevibecode/skills/indexion-readme.md) — skill · 5100 installs
- [readme-generator](https://affpapa.org/en/nevibecode/skills/readme-generator.md) — skill · 313 installs
- [make-documentation](https://affpapa.org/en/nevibecode/skills/make-documentation.md) — skill · 1500 installs
- [readme-updater](https://affpapa.org/en/nevibecode/skills/readme-updater.md) — skill · ★ 788 repo stars

From the same set: [gupsammy/claudest](https://affpapa.org/en/nevibecode/by/gupsammy/claudest.md) — 47 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
