README.md

Song2Quiz

English | 简体中文

An advanced lyrics analysis and quiz generation system that leverages AI to provide deep semantic understanding of song lyrics.

Documentation

Full Documentation

Quick Start

# Clone the repository
git clone https://github.com/technohippies/song2quiz.git
cd song2quiz

# Create and activate virtual environment
uv venv .venv
source .venv/bin/activate  # Mac or Linux
# or
.venv\Scripts\activate     # Windows

# Install dependencies
uv pip install -r requirements.txt

# Set up environment variables
cp .env.example .env
# Edit .env with your API keys

License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.