Absolutely! Here's the complete, cleaned, and decorated README.md in a single block β ready for copy-paste:
# π§ β¨ Code Documentation Generator (LLM + Novita.ai)
This project uses **Python + FastAPI** with a **Novita.ai-powered LLM** to generate high-quality inline code comments and documentation from pasted or uploaded code.
> π Ideal for developers building AI assistants, internal tools, or automated doc generators.
---
### π Create & Activate a Virtual Environment
#### π» Windows (Command Prompt)
```bash
python -m venv venv
venv\Scripts\activate
```
#### πͺ Windows (PowerShell)
```powershell
python -m venv venv
.\venv\Scripts\Activate.ps1
```
#### π§ Linux / macOS
```bash
python3 -m venv venv
source venv/bin/activate
```
---
### π¦ Install Dependencies
```bash
pip install -r requirements.txt
```
> π‘ Tip: Make sure you're inside the virtual environment before running this.
---
### π Add Environment Variables
Create a `.env` file in the `/backend` directory:
```env
NOVITA_API_KEY=your_novita_api_key_here
```
> π‘οΈ Keep this file secure and **do not commit it to version control**.
---
### π Run the Application
#### π Basic Python Run:
```bash
python main.py
```
#### π» macOS/Linux Alternative:
```bash
uvicorn main:app --reload
```
## π Features
* β
Paste or upload code
* π§ Inline and function-level comments
* π JSON-style documentation output
* π Ready to plug into web UI or dev tools
## π€ Contributing
Feel free to fork this project, make changes, and submit pull requests. For major changes, please open an issue first to discuss what you'd like to change.
```
---
Let me know if you'd like a matching `.env.example`, `requirements.txt`, or frontend `README` too!
```