Never Write a README.md from Scratch Again — Meet readmeai

A developer built readmeai, a Python CLI that scans project structure and config files, then uses an LLM to generate a complete README.md with badges, install instructions, and usage examples. The tool runs locally with Ollama support, has zero heavy dependencies, and is available on PyPI under MIT license.

Every developer has been there. You finally finish that side project, push it to GitHub, open the repo and the README.md is just project-name . You tell yourself you'll fix it tomorrow. Tomorrow becomes next week. The repo quietly gathers dust. The excuse is always the same: writing a good README is harder than it looks. You need a hero description, install instructions, usage examples, badges, a contributing guide, a license section and you have to make it not look like a templated ghost wrote it. It's not technical work; it's polishing work. And polishing work is the first thing that gets pushed aside when the next idea hits. That's exactly why I built readmeai. It's a small Python CLI that scans your project structure, reads your key config files pyproject.toml , package.json , Cargo.toml , go.mod , Dockerfile , … and asks an LLM to generate a complete, badge-laden README.md ready to commit. One command, about ten seconds, and your repo stops looking orphaned. Local-first if you want it Ollama works out of the box , zero heavy dependencies requests is the only one , MIT-licensed, on PyPI today. Suggested section headers for the rest of the article: