GitHub README Generator 🤖

AI-Powered Documentation Generator using Ollama Local AI

Description

Transform any GitHub repository into professional, comprehensive README documentation with:

• 🏗️ Detailed architecture diagrams (Mermaid)
• 📂 Complete folder structure analysis
• 🌿 Multi-branch support and comparison
• 💻 Installation and usage instructions
• 🤝 Contribution guidelines
• 🚀 Future roadmap suggestions

Tech Stack

• Backend: Python, FastAPI, LangChain
• AI: Ollama (Local AI) with llama3.2 or qwen2.5-coder
• Frontend: Vanilla HTML, CSS, JavaScript
• Libraries: GitPython, marked.js, mermaid.js, highlight.js

Features

✨ Automated Documentation Generation

• Analyzes repository structure and code
• Generates professional README with architecture diagrams
• Supports multi-branch analysis (up to 10 branches)
• No API costs - runs completely locally

🎨 Modern UI

• Clean, dark-mode interface
• Real-time loading status
• Beautiful markdown rendering
• Interactive mermaid diagrams
• Syntax-highlighted code blocks

Installation

Prerequisites

• Python 3.8+
• Git
• Ollama (Download)

Setup

1. Install Ollama and pull a model:

   ollama pull llama3.2

2. Clone this repository:

   git clone https://github.com/Atharva-Gadi/Github-README-generator.git
   cd Github-README-generator

3. Install dependencies:

   pip install -r requirements.txt

4. Run the server:

   python main.py

5. Open in browser:

   http://localhost:8000
   

Usage

1. Paste a GitHub repository URL
2. Click "Generate Documentation"
3. Wait for AI analysis (30-60 seconds)
4. View, copy, or download the generated README!

Credits

Built by Atharva Gadi

Powered by Ollama Local AI 🤖