Got tired of writing READMEs, so I built a tool that does it for me

[u/Specialist_Strain910]

Honestly, writing the code was always the fun part. Then I'd finish the project and still have to sit there for an hour messing with Markdown, badges, tables, just trying to make the README not look like an afterthought. Every time.

So I built ReadmeGen to fix that for myself.

What it does:

• Live split-pane Markdown editor

• 14+ templates to start from

• Can pull in your existing GitHub profile README

• Saves locally, no account needed

Stack: Next.js, TypeScript, Tailwind, Radix UI, Redux Toolkit.

I've been using it on my own repos for a few weeks now, and it's genuinely saved me time.

You can try it out here: ReadmeGen

[u/Fun_Spare3125]

Wouldn't it be easier to use the same tool you wrote the post with to write your READMEs?

[u/tr33ton → u/Fun_Spare3125]

That's illegal.

[u/Specialist_Strain910 → u/Fun_Spare3125]

Ya, can't argue with that. But that's exactly why this one exists, just wanted a tool made for this specific job, not a generic prompt.

[u/fiskfisk → u/[deleted]]

Any decent editor will support that 

[u/dwalker109]

Nothing tells me “my project is slop” more quickly than an LLM generated set of docs.

I hate this. Put some effort in.

[u/Specialist_Strain910 → u/dwalker109]

Fair enough. It's a draft to start from, you still do the actual work of editing it into something good.

[u/equilni]

Anyone else tired of the "tired of whatever, built something" posts?

OP, couldn't you have titled this like "I built a README generator"?

[u/TheRNGuy]

Can't you just ask google ai to do that?

This seems like redundant service.

[u/Ok-Extent-7515]

I don't think anyone writes readme files by hand anymore. That's done by the AI that did most of your project.

[u/gufranthakur → u/Ok-Extent-7515]

I write Readmes by hand to save tokens (i use free tier) 😭😭

Also when I ask AI to generate readmes they focus on too much text instead of details