Back to Cookbook

README Reviver

Generate a README that matches what the code actually does

Your README was written months ago and reality moved on. Your Claw reads the actual repo and drafts a README that matches what the code really does, not what somebody remembers it doing.

House RecipeWork2 min

INGREDIENTS

🐙GitHub

PROMPT

Generate a README for my project by reading the actual codebase. Don't ask me to describe the project — figure it out from the code. Include: (1) Project overview — what it does, inferred from the code, (2) Quick start — installation and running, from package.json/requirements.txt/etc., (3) Configuration — environment variables and config files referenced in code, (4) API reference — endpoints and their parameters (if applicable), (5) Architecture — how the project is structured, key directories and their purpose, (6) Contributing — how to set up for development. If there's an existing README, preserve anything useful but fix anything that contradicts the code. Repo: [share your repo or key files]

How It Works

Instead of writing a README from memory (which is how they go stale in the

first place), your Claw reverse-engineers the project structure and generates

documentation from the source of truth: the code itself.

What You Get

  • Project overview inferred from code structure and config
  • Accurate installation steps from actual dependency files
  • API documentation from route definitions and handlers
  • Environment variable documentation from code references
  • Architecture overview from directory structure and imports

Setup Steps

  1. Point your Claw at your repo
  2. Optionally share your old README for tone and structure reference
  3. Review the generated README and refine

Tips

  • Share the old README so the Claw preserves useful context (badges, links, license)
  • Ask for different sections: quickstart, contributing guide, architecture docs
  • Pair with the Doc Drift Detector to keep it current going forward
  • Can also generate CONTRIBUTING.md, CHANGELOG.md, and API.md
  • For open source projects, ask it to include a "first issue" guide for new contributors
Tags:#documentation#readme#open-source#automation