AI README Generator

Gemini

Describe your project (name, stack, features, scripts) and get a complete GitHub-ready README with badges, TOC, installation, usage, and contributing sections.

Input

Try:

Project details0 / 20,000

README.md

Paste your input on the left and hit Generate

Examples

Node CLI project

Project: cool-cli
Description: A tiny CLI that turns markdown into slides.
Stack: Node.js, TypeScript, Commander, marked
Features: --watch mode, custom themes, PDF export
Scripts: dev, build, start
License: MIT

About this tool

Describe your project (name, stack, features, scripts) and get a complete GitHub-ready README with badges, TOC, installation, usage, and contributing sections.

Every request is sent server-side to the Gemini 2.5 Flash model with a task-specific system prompt tuned for docs work. Your input is not persisted on our servers — we only keep an anonymised metric (task, input length, latency) so we can improve the tool.

Combine this with our other AI developer tools and privacy-first developer utilities to move faster in your day-to-day work.

FAQ

What sections does the README include?▾

Title, badges placeholder, Overview, Features, Tech Stack, Table of Contents, Getting Started (Prerequisites, Installation, Configuration, Running), Usage, Scripts / API, Project Structure, Contributing, License, Acknowledgements.

Can I customise the tone or audience?▾

Yes — add a line like "Audience: beginner developers" or "Tone: professional" to your input.

Does it generate badges?▾

It includes placeholder shields.io badges — replace the placeholders with your actual repo path.

What if I have limited information?▾

The generator fills in sensible placeholders clearly marked with <angle-brackets> so you know exactly what to replace.