From 566696cee5844e71c43545f00cb66d329d63c3e4 Mon Sep 17 00:00:00 2001
From: "Jason A. Donenfeld" <Jason@zx2c4.com>
Date: Mon, 20 Aug 2012 04:21:20 +0200
Subject: Add readme.

---
 README.mkd | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.mkd

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`
-- 
cgit v1.2.3-59-g8ed1b