ReadmeGen logoReadmeGen

Generate professional GitHub README files. Fast.

Generate READMEs in under 60 seconds
ReadmeGen makes README creation fast, consistent, and professional. Just run readmegen init and follow the interactive prompts — no configuration needed.
Animated demo showing ReadmeGen CLI generating a professional README file with templates and options

The Problem

# My Project TODO: Write description // Installation instructions

Writing README files is time-consuming and error-prone. Inconsistent formatting or missing sections can make projects look unpolished, and developers often struggle to know what to include.

The Solution

ReadmeGen generates professional README files instantly using fully-tested templates. Run readmegen init, answer a few prompts, and get a GitHub-ready README with proper sections, badges, and formatting — no templates to maintain, no complex setup.

ReadmeGen offers three professional templates:
• Minimal — Clean, essential sections only
• Standard — Comprehensive with table of contents, installation, usage
• Fancy — Rich formatting with badges, emojis, and advanced sections

Install

Python Package
pip install readmegen-oss
readmegen init

Works immediately after install — no additional setup required.

Workflow

1

Install ReadmeGen

Install the package via pip - no dependencies needed
↓
2
readmegen init
Initialize your project with smart defaults and interactive prompts
↓
🤖

Optional AI Enhancement (Future)

Currently a placeholder; planned for future releases to rewrite content and add contextual sections.
AI analyzes your project structure
Generates contextual content for features and usage
Creates professional, engaging descriptions
↓
3
readmegen generate
Generate your README.md with chosen template and options
Generated README.md file showing professional formatting with badges, sections, and proper markdown structure
Open Source

• Zero-friction CLI — works immediately after install
• Fully tested templates with consistent output
• Smart defaults — auto-detects project name, sensible prompts
• Comprehensive error handling — clear messages with debug info
• Lightweight — minimal dependencies (typer, jinja2, rich, questionary)