Hey devs! 👋 I recently built Dokugen – an AI-powered tool that generates README.md files automatically based on your GitHub repository.
I created this because I noticed many devs either:
Spend too much time writing detailed READMEs
End up with incomplete or missing project documentation
So I thought: Why not automate it?
What is Dokugen?
Dokugen is an open-source CLI tool that scans your GitHub repo and instantly generates a well-structured, professional README for you. It analyzes your code and produces:
✅ A clear project description
✅ Installation & setup steps
✅ Usage examples
✅ Features & technologies used
✅ Contributing guidelines
All in just one command!
How It Works
1️⃣ Install Dokugen:
npm install -g dokugen
2️⃣ Run it in your project folder:
npx dokugen generate
3️⃣ Boom! Your README.md is generated.
Why I Built This
I've seen many cool open-source projects without a proper README – which makes them hard to understand and use. I wanted to fix that.
With Dokugen, you can:
🚀 Save time writing documentation
🔥 Make your projects look professional instantly
🤝 Attract more contributors to your repo
🚀 Try It Out!
Dokugen is free and open-source! You can check it out here:
🔗 GitHub:
github.com/samueltuoyo15/Dokugen
Would love to hear your thoughts! What do you think? Any features you'd like me to add? Let’s discuss in the comments! 😊
Top comments (1)
Please everyone drop your thoughts