# generate-readme

> Generate or refresh a comprehensive, professional README.md for a repository, with architecture overview, mermaid and o…

Generate or refresh a comprehensive, professional README.md for a repository, with architecture overview, mermaid and optional C4 diagrams, repository structure, dependencies, and API documentation. Use whenever the user asks to create, write, update, improve, or regenerate a README, project documentation, or a project overview page — even if they just say "document this project" or "this repo needs docs".

- Type: Skill
- Made by: divar-ir
- Category: Writing
- Formats: Skills
- Version: 4cefcdd
- Source: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme
- Page: https://pluginboard.ai/skills/generate-readme

## Works with

- ChatGPT
- Claude
- Gemini
- GitHub Copilot
- Cursor
- Claude Code
- Codex
- Antigravity
- Gemini CLI
- Replit
- OpenClaw
- OpenCode
- Hermes Agent

## Install

### ChatGPT

In ChatGPT: Download the generate-readme folder and zip it, then Plugins → Skills → Create → Upload from your computer. Business and Enterprise plans.

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### Claude

In Claude (web or desktop): Download the generate-readme folder and zip the folder itself, then upload it in Customize → Skills.

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### Gemini

In Gemini: Download the generate-readme folder, then at gemini.google.com click Customize → Skills → Create → Upload and pick the folder (or a .zip of it).

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### GitHub Copilot

Run in your terminal:

```shell
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.copilot/skills/generate-readme
```

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### Cursor

Run in your terminal:

```shell
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.cursor/skills/generate-readme
```

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### Claude Code

Run in your terminal:

```shell
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.claude/skills/generate-readme
```

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

Or all of AI Doc Gen, in Claude Code:

```text
/plugin marketplace add divar-ir/ai-doc-gen
/plugin install ai-doc-gen@divar
```

### Codex

Run in your terminal:

```shell
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.agents/skills/generate-readme
```

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### Antigravity

In Antigravity: Copy the generate-readme folder into ~/.gemini/config/skills (Antigravity app and IDE) or ~/.gemini/antigravity-cli/skills (Antigravity CLI).

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### Gemini CLI

Run in your terminal:

```shell
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.gemini/skills/generate-readme
```

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### Replit

Run in your terminal:

```shell
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme .agents/skills/generate-readme
```

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### OpenClaw

Run in your terminal:

```shell
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.openclaw/skills/generate-readme
```

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### OpenCode

Run in your terminal:

```shell
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.config/opencode/skills/generate-readme
```

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

### Hermes Agent

Run in your terminal:

```shell
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.hermes/skills/generate-readme
```

View the folder on GitHub: https://github.com/divar-ir/ai-doc-gen/tree/HEAD/skills/generate-readme

---
From Pluginboard (https://pluginboard.ai).