Upload README.md

README.md

@@ -0,0 +1,60 @@
+# 🌍 Multilingual Chatterbox TTS Server for Windows PC
+# Portable Installer Build by LeeAeron / @li_aeron
+# Git: https://github.com/LeeAeron/chatterbox
+
+## ✨ Key Features
+
+🌐 **24+ Languages:** Arabic, Chinese, Danish, Dutch, English, Finnish, French, German, Greek, Hebrew, Hindi, Italian, Japanese, Korean, Malay, Norwegian, Polish, Portuguese, Russian, Spanish, Swedish, Swahili, Turkish
+
+🎤 **Voice Cloning:** Clone any voice using reference audio files
+
+🎤 **Stress marks detection for russian language:** Enter propmpt in russian with stress marks and get realism-like voice!
+
+📚 **Audiobook Generation:** Process entire books with automatic text chunking
+
+⚡ **GPU Acceleration:** NVIDIA (CUDA) and AMD (ROCm) support
+
+🌐 **Modern Web UI:** Intuitive interface with real-time audio playback
+
+📡 **FastAPI Server:** RESTful API with interactive documentation
+
+## 🔩 System Requirements
+
+- **Windows 10/11** (64-bit) or **Linux**
+- **Python 3.10+**
+- **4GB+ RAM** (8GB+ recommended)
+- **5GB+ storage** for models
+- **GPU (Optional):** NVIDIA with 4GB+ VRAM or AMD RX 6000/7000 series
+
+## 🎤 Voice Management
+
+**Predefined Voices:** Place `.wav`/`.mp3` files in `./voices` directory
+
+**Voice Cloning:** Upload reference audio via Web UI (stored in `./reference_audio`)
+
+## ⚙️ Configuration
+
+Edit `config.yaml` for settings:
+```yaml
+server:
+  host: "127.0.0.1"
+  port: 8004
+
+tts_engine:
+  device: "auto"  # auto, cuda, cpu
+  
+generation_defaults:
+  temperature: 0.7
+  language: "en"
+```
+
+## 📜 License
+
+MIT License
+
+## 🙏 Acknowledgements
+
+- Original sources: THX to [Resemble AI](https://www.resemble.ai/) for [Chatterbox TTS](https://github.com/resemble-ai/chatterbox)
+
+## TO DO:
+- Implement stress marks setup from UI for russian language (to use as all-in-one)