about summary refs log tree commit diff
path: root/packages/music-organizer/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'packages/music-organizer/README.org')
-rw-r--r--packages/music-organizer/README.org21
1 files changed, 21 insertions, 0 deletions
diff --git a/packages/music-organizer/README.org b/packages/music-organizer/README.org
new file mode 100644
index 0000000..a42a196
--- /dev/null
+++ b/packages/music-organizer/README.org
@@ -0,0 +1,21 @@
+#+TITLE: music organizer
+
+the tool takes a couple of arguments:
+- ~-dest~: where will the music be stored
+- a list of directories to scan
+
+all files that have tags that can be read will be processed and moved to the specified destination.
+
+files are organized like this: ={artist}/{album}/{track number} {track title}.{track format}=
+
+the tool ensures that files are not already present in the destination.  if there's already a file with the same name, it checks that the md5 sum of the files are identical.  if they are not, it logs a message.
+
+* build
+#+BEGIN_SRC sh
+go build
+#+END_SRC
+
+* install
+#+BEGIN_SRC sh
+go install
+#+END_SRC