# AI README Generator - ShipDocs

> Paste a public GitHub, GitLab, or Bitbucket URL and get a complete `README.md` generated from the repo's actual source. Free, no signup.

**URL:** https://shipdocs.sh/tools/readme

## What it produces

The output is a single Markdown file that includes:

- **Project name and one-line summary** inferred from the actual entry points.
- **Tech stack** - languages, frameworks, build tools, runtimes, package managers detected from the file tree and manifests.
- **Quick start** - install + run instructions tailored to the detected stack (e.g. `npm install` + `npm run dev`, `pip install -r requirements.txt`, `cargo run`, etc.).
- **Project structure** - the top-level directories and what they're for.
- **Key concepts** - the handful of files / modules a new contributor needs to read first.

## How it works

1. You enter a public repo URL.
2. ShipDocs's indexer reads the file tree, manifests (`package.json`, `pyproject.toml`, `Cargo.toml`, `go.mod`, etc.) and a sampled cross-section of source files.
3. An LLM grounds its draft in those files and emits a Markdown README.
4. You copy or download `README.md`.

## Limits

- Public repos only.
- Output is a single file; no per-module docs.
- For per-component documentation, AI chat over your code, and private-repo support, use the full ShipDocs product: https://shipdocs.sh/.

## Why it's better than a generic ChatGPT prompt

The output is grounded in the *actual source files*, not the existing README, so you get accurate stack/quick-start instructions even when the upstream README is out-of-date or missing.

## Pricing

Free. No signup, no credit card.