Your READMEis probably bad.Let's find out.
Paste a public GitHub repository and we'll score your README, roast it with Gemma, and tell you exactly what to fix.
What you'll get
“Your README is actually pretty solid. I came here expecting chaos. Unfortunately, it's good. Think about what you've become.”
How ReadMeRoast Works
From an unread, confusing README to clear, developer-friendly documentation in under 15 seconds.
Paste your repo
Drop in any public GitHub repository URL. No auth tokens or signups needed.
Get roasted
Gemma analyzes clarity, setup steps, examples, and visuals with a savage yet constructive review.
Fix your README
Get an evidence-based markdown rewrite that improves structure without inventing fake details.
Everything you need to know
Does ReadMeRoast store or train on my repository code?
No. ReadMeRoast only reads public README files via GitHub's public API to analyze documentation quality. We do not clone repositories or train on your data.
What AI model powers the roast and fixes?
ReadMeRoast is powered by Google's Gemma 2 open-weight AI model, configured with strict anti-hallucination guidelines.
Can I use ReadMeRoast for private repositories?
Currently ReadMeRoast only supports public GitHub repositories without requiring GitHub OAuth or personal access tokens.
Does 'Fix My README' invent fake features?
No. The generator follows a strict zero-hallucination prompt that only restructures verified facts and uses explicit placeholders for missing instructions.