git.lirion.de

Of git, get, and gud

aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Pfeiffer <coding _ lirion.net> 2014-08-08 21:23:12 +0200
committerHarald Pfeiffer <coding _ lirion.net> 2014-08-08 21:23:12 +0200
commitbab3be836685e0cbc66ca5fbe04e2aaa60647ca1 (patch)
treed8f1ff0cbe271acc62c270e95c6116bd136353e8
parent3a161094b37e903db97a6ff41961c7168118818c (diff)
downloadmp3dir2html-bab3be836685e0cbc66ca5fbe04e2aaa60647ca1.tar.bz2
README weeeee
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..921172e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# mp3dirlist
+
+This is a tool to create an HTML file containing all music in the current directory. This is done by reading all id3 tags recursively and then assembling the rest.
+
+**This isn't even alpha, it's experimental**. It's quick and dirty still and needs some polishing :)
+
+Requirements
+------------
+
+* [Bash](http://www.gnu.org/software/bash/) (Bourne Again Shell)
+* [ExifTool](http://www.sno.phy.queensu.ca/~phil/exiftool/) -- most likely available for your system as **Image::ExifTool**, provided via something like *libimage-exiftool-perl*
+* [GNU coreutils](http://www.gnu.org/software/coreutils/), [sed](http://www.gnu.org/software/sed/) and [(g)awk](http://www.gnu.org/software/gawk/) -- most likely already installed on your system