Your one-stop solution for automatically generating rich, visually stunning READMEs using AI agents!
- 🧠 Multi-AI Agent Architecture: Harnesses the power of multiple AI agents for content generation.
- 🎨 Visual & Interactive: Produces READMEs with badges, emojis, and visual elements.
- 🔥 Plug & Play: Just point it to your repo and get a ready-to-use README.
- 🦾 Python Powered: Built with Python for simplicity and extensibility.
- 🛡️ MIT Licensed: Open-source and free to use!
.
├── .env # Environment configuration
├── LICENSE # MIT License
├── agents/ # AI agent modules
├── app.py # Main application entrypoint
├── core/ # Core logic and utilities
└── readme.md # (You are here!)
# 1️⃣ Clone the repository
git clone https://github.com/KunjShah01/github-multi-ai-agent-readme-generator.git
# 2️⃣ Navigate to the project directory
cd github-multi-ai-agent-readme-generator
# 3️⃣ (Optional) Create a virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# 4️⃣ Install dependencies
pip install -r requirements.txt
# 5️⃣ Create your .env file and set necessary environment variablespython app.py- The app will guide you through generating a README for your project using multiple AI agents.
- You can customize agent prompts and output style.
- Add your own agents in the
agents/directory. - Tweak core logic in
core/. - Modify environment/configs in
.env.
This project is licensed under the MIT License. See the LICENSE file for details.
- Kunj Shah
KunjShah01
Contributions, issues and feature requests are welcome!
Feel free to open an issue or submit a pull request.
Give a ⭐️ if you like this project!
Share it with your friends and colleagues!
