Add basic README

This commit is contained in:
Jakob Moser 2025-05-21 13:43:08 +02:00
parent 59fd6eefb6
commit 963adf4c77
Signed by: jakob
GPG Key ID: 3EF2BA2851B3F53C

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# Karaokatalog
Tools to manage an Ultrastar DX song library. Features include:
1. Deduplication
## Setup
```bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
## Run
### Deduplication
If your song library is stored at `/path/to/library`, run:
```bash
python3 -m karaokatalog.deduplicate /path/to/library
```