DEV Community

feiwei8889
feiwei8889

Posted on

readmegen — Generate beautiful README.md in seconds (12 templates, open source)

tags: python, github, opensource, productivity, showdev

readmegen: Beautiful READMEs in Seconds 🎉

Every developer knows the pain — you've built something awesome, but writing a decent README feels like a chore. readmegen fixes that.

What It Does

pip install git+https://github.com/feiwei8889/readmegen.git
readmegen
Enter fullscreen mode Exit fullscreen mode

An interactive wizard walks you through project name, features, install method, and picks the perfect template. Zero config — just answer a few questions and get a professional README.

12 Professional Templates

Template Best For
default General projects, CLI tools
minimal Small utilities, scripts
project Large frameworks, platforms
api REST/GraphQL APIs
cli-tool Command-line tools
library SDKs, packages
startup SaaS products
gamedev Game engines, mods
awesome Curated lists
profile GitHub profile pages
docker Container images
chinese 中文开源项目

Key Features

  • Rich-powered interactive CLI with beautiful terminal UI
  • Auto-generated shields.io badges (license, stars, version, CI, coverage...)
  • Automatic Table of Contents
  • Multi-language support
  • Non-interactive mode for CI/CD (readmegen --name "MyTool" --template cli-tool)
  • JSON batch input for bulk generation

Live Demo

readmegen --template cli-tool --name "MyTool" --tagline "An awesome CLI tool"
# -> Writes README.md with badges, ToC, features, install guide, contributing section
Enter fullscreen mode Exit fullscreen mode

Pro Version ($5)

Get 20+ exclusive templates, AI-powered content suggestions, custom branding, and priority support.

https://ko-fi.com/feiwei8889


GitHub: https://github.com/feiwei8889/readmegen

Install: pip install git+https://github.com/feiwei8889/readmegen.git

Support: https://ko-fi.com/feiwei8889

Built with Python + Rich. Star the repo if you find it useful! ⭐

Top comments (0)