Fast, AI–driven README creation powered by Moonshot Kimi K2 & Agno
✨Try out here : https://readmegenerator.streamlit.app/
Clone any public GitHub repository, scan its structure, and get a production-ready README in seconds – all served in a simple Streamlit web app.
- Python ≥ 3.13
- An OpenRouter API key
# 1. Clone the project
git clone https://github.com/<your-org>/bfwai-kimi-agno.git
cd bfwai-kimi-agno
# 2. Create and activate virtual env
python -m venv venv
source venv/bin/activate # or .\venv\Scripts\activate on Windows
# 3. Install
pip install -r requirements.txt
# (or use `pip install .` with the supplied pyproject.toml)
# 4. Start the app
streamlit run main.py # opens http://localhost:8501- Paste an OpenRouter API key in the sidebar
- Enter any public GitHub URL
- Click Generate README
- Copy the generated markdown or download as
README.md
The tool respects .gitignore and never saves the repository after the session ends—everything is cleaned up automatically.
| Layer | Tooling / Library |
|---|---|
| Language | Python 3.13 |
| Framework | Streamlit |
| LLM & routing | OpenRouter → Moonshot AI/Kimi K2 |
| Agent runtime | Agno |
| Git bindings | GitPython |
| Package mgmt | pyproject.toml |
- Fork the repo
- Create a feature branch:
git checkout -b my-feature - Add tests for new logic (pytest preferred)
- Ensure linting passes:
ruff check . ruff format .
- Push & open a Pull Request
- Your change will be reviewed and merged. Thanks!
Made with ❤️ by Build Fast with AI