README Generator
Commercial use OK
380+ models
No watermark
No sign-up needed
Model:
+ GPT-5, Claude, Gemini
Describe your project (or paste package.json / pyproject.toml / Cargo.toml) and get back a polished README.md — title, shields, install, quickstart, features, contributing, license. Pick your project type, length, and tone.
Advanced options
Result
Tokens running low.
Get More Tokens
❤️ Love Free.ai? Tell your friends!
Sign up to get a referral link and earn 25,000 tokens per friend.
Want more?
Sign up free for 5K tokens/day + 10K bonus
Sign Up Free
Processing your request...
Generate project README files with free AI. Professional documentation in seconds.
How to Use README Generator
1
Enter your input
Type text, upload a file, or describe what you want. No account needed.
2
Click generate
Our AI processes your request in seconds using the best open-source models.
3
Download & share
Download, copy, or share your result. Free for personal and commercial use.
Use this tool via API
Automate this tool from your own code. OpenAI-compatible REST endpoint, Bearer-token auth, no extra SDK required. Token costs match the web interface.
curl -X POST https://api.free.ai/v1/chat/ \
-H "Authorization: Bearer sk-free-..." \
-H "Content-Type: application/json" \
-d '{"model": "qwen-coder", "messages": [{"role": "user", "content": "Write a Python function that reverses a string."}]}'README Generator — FAQ
Describe your project in 2-3 sentences (or paste package.json / pyproject.toml / Cargo.toml) and get back a polished README.md — title, shield badges, table of contents, install, quickstart, features, usage, optional contributing / license / FAQ sections. Pick project type (library / CLI / webapp / API / mobile / plugin / dataset / paper / template), length (minimal → exhaustive), and tone (professional / friendly / technical / marketing / academic).
readme-so and makeareadme.com are form-fill templates — you manually tick boxes and get stock sections. Free.ai is generative — it writes copy specific to YOUR project, inferring reasonable install commands / API shape / tone from your description. Copilot ($10/mo) is inline-IDE and generates README text paragraph by paragraph as you type; Free.ai produces the whole file in one shot. Use readme-so for pure structure; Free.ai when you want actual copy.
The system prompt explicitly forbids inventing features. If the description is vague, the model inserts "TODO" placeholders. Always read the generated README and remove TODOs (or replace with actual content) before publishing — treat the output as a polished first draft, not a ship-ready file.
Yes when checked — a row of 3-6 shields (build, version, license, downloads, coverage) using placeholder URLs you customize to your repo. The model picks sensible defaults based on project type (library gets npm-version or pypi-version; CLI gets install count; webapp gets uptime).
Minimal (10 lines) for internal utilities nobody will discover. Standard (~80 lines) for most open-source projects — hits the sweet spot of findability without walls of text. Detailed (~200 lines) for projects you actively market. Exhaustive (docs-style, 300+ lines) when the README is your primary docs site.
Yes — pick "Marketing" tone. You get a strong headline, benefit-led copy, social-proof placeholders, stronger CTAs. The sections stay accurate (no invented features) but the prose is pitch-style. Good for SaaS launch repos, portfolio projects, product-hunt-style releases.
Yes — pick "Academic" tone. The README includes a "Citation" section with a BibTeX template and a request-if-used line, plus methods and reproducibility fields. Good for research paper repos and model / dataset releases.
Yes — the result panel has Markdown/Preview toggle buttons. Preview renders client-side with a GitHub-flavored subset (headings, bold/italic, code blocks, inline code, lists, links). Not as polished as GitHub itself — always do a final test by pushing to a repo.
The default generator assumes a single-project README. For a monorepo root README, describe the repo as a monorepo in your input ("contains 3 packages: foo, bar, baz") — the model adds a packages table and skips install instructions (because install is per-package). For per-package READMEs, run README Generator once per package.
Qwen 3 Coder (free, default) handles 95% of READMEs well. Qwen 3 30B is more polished and balanced in marketing tone. Premium Claude Sonnet 4 is noticeably better at marketing-tone copy and exhaustive-length READMEs — worth the paid tokens for your landing-page repo.
The description is sent to the model, processed, and discarded. Not stored, not used for training. For maximum privacy pick Qwen 3 Coder — self-hosted on Free.ai's GPUs.
Yes — POST to /v1/chat/ with the README system prompt (type + length + tone + section flags) and the project description as the user message. Useful for automating README generation during project scaffolding. See /api/.
How would you rate this tool?