From 87776e74ecb2a49dfd04d2177f1bee30ae562184 Mon Sep 17 00:00:00 2001
From: Anton Sarukhanov <code@ant.sr>
Date: Fri, 20 Dec 2019 23:05:53 -0500
Subject: [PATCH] clarify doc
---
README.md | 28 ++++++++++++++++++++++++++++
karaokeclean.py | 2 ++
2 files changed, 30 insertions(+)
diff --git a/README.md b/README.md
index edf51c2..49bda35 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,31 @@ Removes redundant files from a karaoke collection.
A collection may include multiple versions of the same song, from multiple
karaoke studios/labels. This script finds such songs, and moves the less-desired
copies into a different directory.
+
+There's nothing fancy here, just looking at filenames and choosing the ones we want.
+
+## Usage
+
+Probably don't. This was a one-off script and it's probably not very useful to
+anyone else, except as an example of a quick and dirty way to sort a bunch of files.
+
+## Example filenames
+
+### Before
+
+* `Karaoke/ArtistA - TrackX [Label1].mp3`
+* `Karaoke/ArtistA - TrackX [LabelF].mp3`
+* `Karaoke/ArtistA - TrackX [Label#@!].mp3`
+* `Karaoke/ArtistA - TrackX [LabelBest].mp3`
+* `Karaoke/ArtistA - TrackX [Label2].mp3`
+
+### After
+
+Assuming we configure `LabelBest` above the others...
+
+* `Karaoke/ArtistA - TrackX [LabelBest].mp3`
+
+* `Other/ArtistA - TrackX [Label1].mp3`
+* `Other/ArtistA - TrackX [LabelF].mp3`
+* `Other/ArtistA - TrackX [Label#@!].mp3`
+* `Other/ArtistA - TrackX [Label2].mp3`
diff --git a/karaokeclean.py b/karaokeclean.py
index d77f682..c45d51e 100644
--- a/karaokeclean.py
+++ b/karaokeclean.py
@@ -12,6 +12,8 @@ EXTRA_DIR = "/media/anton/Karaoke/Karaoke_Extra"
FILENAME_REGEX = re.compile(r"(?P<song>.*)\[(?P<label>.*)\](?P<ext>.*)")
+
+# List of karaoke labels in order of preference.
PREFERENCES = [
"Karaoke",
"SC Karaoke",
--
GitLab