readme-writerlisted

Writes a production-quality README.md for any code repository, grounded entirely in the repo's real contents. Give it a repo link to clone, or paste/upload the repo's files, and it inventories manifests, CI config, build files, and code, works out what kind of project it actually is, and drafts a README using only the sections that project needs — no placeholder text, no invented badges or benchmarks, no boilerplate sections that don't apply. Works the same way regardless of language, stack, or project category. Use whenever asked to write, generate, or improve a README for a repo, or for a specific named project, in whatever wording that request takes.
Zeyad-101/Readme-writer-skill · ★ 0 · Data & Documents · score 72

Install: claude install-skill Zeyad-101/Readme-writer-skill

# README Writer Produces one README.md, grounded in what the repository actually contains. Two failure modes to avoid equally: a generic template with brackets left in, and a confident README that states things the repo doesn't back up. ## Workflow ### 1. Get the repo Auto-detect how it's being handed to you: - **GitHub URL in the request** — shallow clone it: `git clone --depth 1 <url> /home/claude/repo-work/<name>` This works because `github.com` and `codeload.github.com` are reachable. Other hosts (GitLab, Bitbucket, private GitHub) generally aren't — if the clone fails, say so plainly and ask for a zip upload or pasted files instead of retrying silently. - **Uploaded zip/files** (`/mnt/user-data/uploads/`) — unzip to a working directory. - **Pasted file contents / directory listing in chat** — work from that text directly; ask for the specific files you need if the paste is too partial to inventory (e.g. only a tree with no manifest contents). ### 2. Inventory Before drafting anything, build a picture of what's real: - Directory structure (`find . -not -path '*/.git/*' | sort`, or similar) - Manifests: `package.json`, `requirements.txt`/`pyproject.toml`, `Cargo.toml`, `go.mod`, `CMakeLists.txt`, `platformio.ini`, `*.pro` - CI: `.github/workflows/*`, `.gitlab-ci.yml` - Containers/infra: `Dockerfile`, `docker-compose.yml`, `k8s/`, `helm/` - `LICENSE`, existing `README*`, `CHANGELOG.md`, `.env.example` - Entry points and any obviously central source