aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2012-08-20 21:27:46 +0200
committerJason A. Donenfeld <Jason@zx2c4.com>2016-02-21 20:29:48 +0100
commitb5e828d87576c4206ee10151f6697ad9435f72f1 (patch)
tree2d343b06f5f0c9f614cf29a1984d5120e65cbf05
parentWork around as-needed bugs. (diff)
downloadmusic-file-organizer-b5e828d87576c4206ee10151f6697ad9435f72f1.tar.xz
music-file-organizer-b5e828d87576c4206ee10151f6697ad9435f72f1.zip
Import blog to readme
-rw-r--r--README.md40
-rw-r--r--README.mkd25
-rw-r--r--music-file-organizer.pngbin0 -> 498633 bytes
3 files changed, 40 insertions, 25 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ad2671b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Music File Organizer
+
+## Introduction
+
+I've been using this utility since I wrote it 6 years ago, and this afternoon, I cleaned up the code base in order to release it. It's a simple command-line music file organizer. It takes a list of files or directories as program arguments, inspects the tags of all the enclosed music files, and then determines which directories need to be created and what the music file name should be. Plenty of GUI tools do this already, many of which are very customizable, but I have yet to see a command-line utility as simple as this that gets the job done.
+
+The general ingestion routine for acquiring music on the Interwebs is I load it up in <a href="http://musicbrainz.org/doc/MusicBrainz_Picard/">Picard</a> or <a href="http://easytag.sourceforge.net/">EasyTag</a> or another command line utility to adjust the tags, and then run:
+
+ $ organizemusic ~/Downloads/some-silly-m4a-directory
+
+And presto, all the music is moved into the right place.
+
+<img src="music-file-organizer.png" />
+
+It takes care of translating difficult non ASCII character into correct transliterations using <a href="http://site.icu-project.org/">libicu</a> and uses KDE Scott Wheeler's <a href="http://taglib.github.com/">taglib</a> for the audio file tag reading.
+
+## Utilities
+
+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
diff --git a/README.mkd b/README.mkd
deleted file mode 100644
index 71e0931..0000000
--- a/README.mkd
+++ /dev/null
@@ -1,25 +0,0 @@
-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`
diff --git a/music-file-organizer.png b/music-file-organizer.png
new file mode 100644
index 0000000..c3019e8
--- /dev/null
+++ b/music-file-organizer.png
Binary files differ