Code Summary Generator 🤖

Automatically generate professional README files from your codebase using AI!

Transform any project into well-documented code with intelligent analysis. One click, professional documentation.

🚀 Quick Start

Step 1: Install & Setup

1. Install this extension from VS Code Marketplace
2. Open any project folder in VS Code
3. Get your free API key (takes 1 minute) ⬇️

Step 2: Get Your Free Gemini API Key

1. Visit Google AI Studio
2. Click "Create API Key"
3. Copy the generated key (starts with AIza...)

Step 3: Add API Key to VS Code

1. In VS Code, press Ctrl + Shift + P (Windows/Linux) or Cmd + Shift + P (Mac)
2. Type: Preferences: Open User Settings (JSON)
3. Click on it to open your settings.json file
4. Add this line inside the {} brackets:

   "codeSummaryGenerator.apiKey": "paste-your-api-key-here"
   

5. Save the file (Ctrl + S)

Example settings.json:

{
    "editor.fontSize": 14,
    "codeSummaryGenerator.apiKey": "AIzaSyD1234567890abcdef...",
    "workbench.colorTheme": "Dark+"
}

Step 4: Generate Your README

1. Press Ctrl + Shift + P (Windows/Linux) or Cmd + Shift + P (Mac)
2. Type: Generate Summary: Code Summary with AI
3. Press Enter to run the command
4. Wait for processing (30-60 seconds)
5. Done! Your AI-generated README.md is ready

Alternative: Click the "Generate README" button in the status bar (bottom-right corner)

📁 What You Get

After running the extension, you'll find these files in your project:

• 📄 README.md - Professional AI-generated documentation
• 📊 codesummary.json - Structured project analysis
• 📋 codesummary.pdf - Visual code report

✨ Features

• 🧠 Smart AI Analysis - Uses Google Gemini to understand your code
• 📝 Professional Documentation - Creates comprehensive README files
• ⚡ One-Click Generation - Simple status bar button
• 🎯 Context-Aware - Understands your project structure and purpose
• 🔄 RAG Technology - Advanced retrieval for accurate documentation

💡 Perfect For

• 🆕 New projects needing documentation
• 🌟 Open source projects
• 👥 Team collaboration
• 📚 Code reviews and handovers
• 💼 Portfolio projects

❓ Troubleshooting

"API key not found" error?

• Make sure you added the API key to your settings.json
• Check the key starts with AIza and has no extra spaces
• Restart VS Code after adding the key

Extension not working?

• Ensure you have a folder open (not just individual files)
• Try reloading VS Code: Ctrl+Shift+P → Developer: Reload Window

Slow processing?

• Large projects take 1-2 minutes to analyze
• Check your internet connection

🔧 Requirements

• VS Code 1.102.0 or newer
• Internet connection for AI processing
• Project folder opened in VS Code
• Free Google AI API key

📖 How It Works

1. Scans your entire codebase
2. Analyzes code structure and dependencies
3. Uses AI to understand project purpose
4. Generates professional documentation
5. Creates README with proper formatting

🎯 Example Output

The extension generates README files with sections like:

• Project Description - What your project does
• Installation Guide - How to set up the project
• Usage Instructions - How to run/use the code
• Technology Stack - Languages and frameworks used
• Project Structure - File organization
• API Documentation - If APIs are detected

🆘 Need Help?

1. Check that your API key is correctly set
2. Ensure you have a folder open (not just files)
3. Try reloading VS Code window
4. Visit Google AI Studio to verify your API key

🚀 Ready to document your code professionally? Install now and generate your first README in under 5 minutes!

Made with ❤️ for developers who value good documentation

⭐ Rate This Extension | 🐛 Report Issues | 📧 Contact Support