Merge branch 'master' of github.com:tgrosinger/Audio-Shrinker

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2013 Tony Grosinger
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,4 +1,41 @@
 Audio-Shrinker
 ==============
 
-Very easily convert any flacs from an input directory into ogg vorbis in an output directory. Will recursively search through directory, mirroring the structure in the output directory.
+After a bit of reasearch I have determined that OGG Vorbis is the best format to use for audio on mobile devices. It has excellent compression with great quality even at lower bit rates. To simplify the process of comverting my music, this small app will take an input directory and convert the contained audio files using mmpeg.
+
+Installation
+------------
+
+~~~
+# Install some dependencies
+sudo apt-get install build-essential vorbis-tools git autoconf automake libvorbis-dev
+ 
+# If ffmpeg is installed, remove it
+sudo apt-get remove ffmpeg
+ 
+# Now install the new version
+cd /opt
+sudo git clone git://source.ffmpeg.org/ffmpeg.git ffmpeg
+sudo ./configure --enable-libvorbis
+sudo make
+sudo make install
+~~~
+
+Detailed installation instructions can be found in [this blog post](http://tostring.co/audio-transcoding-made-slightly-easier/).
+
+Usage
+-----
+
+A simple help command is included:
+
+~~~
+python audio-shrink.py -h
+~~~
+
+To convert a directory of files:
+
+~~~
+python audio-shrink.py -i <input dir> -o <output dir> -f <input format>
+~~~
+
+The input directory structure will be mirrored in the output directory. For example, album folders will be created if you point the script at an artist folder.