diff --git a/README.md b/README.md new file mode 100644 index 0000000..da4e43f --- /dev/null +++ b/README.md @@ -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 +```