README Generator
Generate professional README.md files for your open-source and SaaS projects.
This is an AI tool. The text you enter is sent to our AI service to generate your result. Our own server doesn't store it or use it for training; if it's down, a backup AI provider may handle it. How we handle your input
How to Use README Generator
- 1Describe the project: what it does, what problem it solves and who it is for. This is the field that decides whether the README is useful.
- 2Add the project name and the tech stack — 'Next.js, TypeScript, Prisma, PostgreSQL, Tailwind CSS'.
- 3Pick a style: Standard Open Source, Minimal, Detailed / Full Docs, or SaaS Product.
- 4Click 'Generate README'.
- 5Replace every bracketed placeholder — features, install commands, licence, acknowledgements — with your real content before committing it.
Frequently Asked Questions
Which style should I pick?
Standard Open Source for a public repo that wants contributors — it includes the contributing and licence sections people look for. Minimal for an internal tool where a wall of badges is noise. Detailed for something with real configuration. SaaS Product when the repo is the product rather than a library.
Are the install commands correct?
They are conventional for the stack you name, not read from your project. Check them against a clean clone — the single most common README failure is install instructions that no longer work, and it is the first thing a new contributor hits.
Does it choose a licence for me?
It leaves a licence section for you to fill in. That is deliberate: picking a licence is a decision with legal consequences, and a generated README asserting MIT on a project you had not decided about would be actively harmful.
Why are there bracketed placeholders?
For features, acknowledgements and anything else it cannot know. They are meant to be obvious so they get replaced — a README shipped with [Feature 1] still in it is the clearest possible signal that nobody read it.
Will it include a contributing section?
The Standard Open Source style does, with the usual fork / branch / commit / push / pull request flow. Adjust it if your project uses a different convention, and link to a CONTRIBUTING.md if you have one.
About README Generator
A README is the first thing anyone sees and usually the last thing anyone writes. The README Generator produces a complete one in Markdown from a project description, a tech stack and a style — installation, usage, features, contributing and licence sections included.
The style setting matters more than it looks. A minimal internal tool does not want a contributing guide and a badge row; an open source library does. Generating the wrong style gives you a document you have to cut down, which is the same work as writing it.
The description field is doing the real work. 'A CLI' produces a generic README; 'a CLI that converts OpenAPI specs to typed TypeScript clients, for teams who hand-write them today' produces one where the opening paragraph is actually worth reading — which is the only part most visitors read.
Two things to fix before committing. Check the install commands against a clean clone, because conventional commands for a stack are not the same as your project's actual commands, and broken setup instructions are the first thing a new contributor hits. And replace every bracketed placeholder — a shipped README still containing [Feature 1] says nobody read it. Your input goes to our own AI server over HTTPS, is used once, and is never stored or used for training. If our server is down, a backup AI provider may handle the request under its own data policy.