Improve instructions

1 files changed, 26 insertions, 2 deletions

diff --git a/sortashuffle.py b/sortashuffle.py
index 1bb7047..6a07c4a 100644
--- a/sortashuffle.py
+++ b/sortashuffle.py
@@ -1,15 +1,39 @@
-#!/usr/bin/env python3
+   #!/usr/bin/env python3
 # sortashuffle.py
 
 # REQUIREMENTS
 # - Must be run as administrator on Windows
 # - All episodes of each show must be in one folder; no season folders!
+# - All episodes must be named so that your filesystem sorts them
+#    properly in episode order when sorted alphanumerically.
+# - All episodes must be named according to my personal conventions.
+
+# NAMING CONVENTIONS
+# All files are named suchly:
+# show-name.S#.E#.title-of-episode.mp4
+#
+# The number of seasons and episodes determines how many zeroes are used
+# as padding. If there are 99 episodes, episode 1 should be 01. If there
+# are 250 episodes, episode 1 should be 001. And so on...
+#
+# Multi-part episodes have their episode numbers collapsed back to the
+# base episode number, and have a, b, c, etc. appended to the episode number.
+# This is a destructive operation which loses the true episode number of
+# multi-part episodes. For example, if we have a 3-part episode, it
+# would look like:
+# show-name.S1.E1a.title-of-episode.mp4
+# show-name.S1.E1b.title-of-episode.mp4
+# show-name.S1.E1c.title-of-episode.mp4
+# show-name.S1.E4.title-of-episode.mp4
+# Notice the jump from E1c to E4?
 
 # USAGE
 # 0. Copy this script to the playlist folder
 # 1. Modify the TARGET variable below
 # 2. Modify the SOURCES variable below
-# 3. Run the script as administrator
+# 3. Run powershell as administrator
+# 4. `cd' into the TARGET directory
+# 5. Run the script.
 #
 # To add/remove shows or regenerate playlist,
 # delete everything in TARGET (except this script)