# Readme Generator

> Draft or refresh a project README from the codebase, not from guesswork

- Skill: `claudifytech/readme-generator` (Agent Skill)
- Install (CLI): `npx skillmds@latest add claudifytech/readme-generator`
- Raw SKILL.md: https://api.skillmd.com/api/skills/claudifytech/readme-generator/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: claudifytech (https://skillmd.com/u/claudifytech)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/claudifytech/readme-generator

---


# README Generator

Produce a clear, accurate README by reading the project, not by guessing.

## When to use
When the user asks to create or update the project README.

## Procedure
1. Gather facts from the repo first:
   - `package.json`, `pyproject.toml`, `go.mod`, or the equivalent, for the name, description, scripts, and dependencies.
   - The entry point and the top-level folder structure.
   - Any existing README, docs, or `.env.example` for the real setup steps.
2. Draft these sections, including only what you can verify from the repo:
   - **Title and one-line description.**
   - **What it does**, in two or three sentences.
   - **Install** and **run** commands, taken from the real scripts, never invented.
   - **Configuration**, if there are environment variables or config files.
   - **Project structure**, if the layout is non-obvious.
   - **License**, if a LICENSE file exists.
3. Keep it honest. If you cannot confirm a step from the repo, leave a clearly marked placeholder rather than guessing.
4. Write the result to `README.md`. If one already exists, preserve any hand-written sections you cannot improve.

## Notes
- Accuracy beats completeness. A short, correct README is better than a long one with wrong commands.