diff options
author | Jason A. Donenfeld <Jason@zx2c4.com> | 2012-08-20 04:21:20 +0200 |
---|---|---|
committer | Jason A. Donenfeld <Jason@zx2c4.com> | 2012-08-20 04:21:20 +0200 |
commit | 566696cee5844e71c43545f00cb66d329d63c3e4 (patch) | |
tree | 941b108038150d06ff966e974fc41b3143b63fc6 | |
parent | Spiffier output. (diff) | |
download | music-file-organizer-566696cee5844e71c43545f00cb66d329d63c3e4.tar.xz music-file-organizer-566696cee5844e71c43545f00cb66d329d63c3e4.zip |
Add readme.
-rw-r--r-- | README.mkd | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/README.mkd b/README.mkd new file mode 100644 index 0000000..5031f35 --- /dev/null +++ b/README.mkd @@ -0,0 +1,23 @@ +Music File Organizer +==================== + +This project ships two very simple utilities for organizing music files. + +### `organizemusic` +This scans recursively all directories and files given as arguments and determines the tags of the audio files. It uses these tags to generate a file name and directory sstructure, normalizes the name to remove non ASCII characters, and then moves the files to their new location inside `$MUSICDIR` or `$HOME/Music`. +``$ organizemusic ~/Downloads/Some-Torrent-Directory/ ~/Desktop/file-from-friend.mp3`` + + +### `readmusictags` +This spits out all the tag data inside the music files given as arguments. +``$ readmusictags ~/some-music-file.flac ~/files/another_music-file.wma`` + +Build Requirements +------------------ +* taglib - http://taglib.github.com/ +* libicu - http://site.icu-project.org/ + + +Build Instructions +------------------ +`$ make` |