# ------------------------------------------------------------------------------
                              Yarock features 
# ------------------------------------------------------------------------------
    * Music collection database (SQLite 3)
    * Browse your local music collection based on cover art 
    * Easy search and filter music collection
    * Manage favorites item (album, artist)
    * Play music directly from collection or playqueue
    * Simple playqueue
    * Smart playlist generator       
    * Support mp3,Ogg Vorbis,flac music files (depending on phonon backend)
    * Support load/save playlist file (m3u, pls, xspf)
    * Play radio stream (tunein, icecast, shoutcast, user stream files)
    * Mp3Gain tag support for volume normalization
    * Contextual info & cover art download (lastfm, echonest, musicbrainz)
    * Last Fm scrobbler
    * Command line interface, Mpris interface
    * Clean and simple user interface 
    * No GNOME or KDE dependancies
# ------------------------------------------------------------------------------
                              Dependencies
# ------------------------------------------------------------------------------
Required dependencies:  
    CMake 2.8.0         - http://www.cmake.org/
    Qt 4.7.0            - http://qt.nokia.com/
    QJson 0.7.1         - http://qjson.sourceforge.net/
    TagLib 1.6.2        - http://developer.kde.org/~wheeler/taglib.html
# ------------------------------------------------------------------------------
                              Build instructions
# ------------------------------------------------------------------------------
On a Debian or Ubuntu system type:
   sudo apt-get install build-essential qt4-dev-tools libphonon-dev libtag1-dev libqt4-sql-sqlite libqjson-dev

Compiling
----------
    $ mkdir build && cd build
    $ cmake ..
    $ make
  
Install on Linux
----------------
   $ make install (as root)

Running
------------
   using local directory
   $ ./build/yarock

Phonon
------
   Yarock player use the phonon capabilities system provided by Qt. You have to 
   install a phonon backend and check your Phonon setup. 
   
   See Phonon backends : VLC, gstreamer, Xine, Mplayer... 
   
   Under some linux distro (tested on Mageia) you need to change link to phonon plugin with 
          ln -s /usr/lib/kde4/plugins/phonon_backend /usr/lib/qt/plugins
     (or) ln -s /usr/lib64/kde4/plugins/phonon_backend /usr/lib64/qt4/plugins
     
     
Audio engine system
-------------------
  By default yarock use phonon as audio engine, since 0.9.64 you can build yarock with 
  phonon and/or standalone vlc angine

    cmake .. -DENABLE_VLC=ON -DENABLE_PHONON=ON

    -DENABLE_VLC=OFF
        Build with vlc audio engine 
        Default: OFF

    -DENABLE_PHONON=OFF
        Build with phonon system as audio layer (work with phonon backend vlc, gstreamer,...)
        Default: ON
        
        
# ------------------------------------------------------------------------------
                               Tips & Tricks
# ------------------------------------------------------------------------------
Change systray icon
-------------------
you can use your on icon for yarock in the systray by using the file 
/home/your name/.config/yarock/systray_icon.png 


# ------------------------------------------------------------------------------
                               Legal Stuff
# ------------------------------------------------------------------------------
Copyright (C) 2010-2013 Sébastien Amardeilh sebastien.amardeilh+yarock@gmail.com

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.