# ------------------------------------------------------------------------------
                              Yarock features 
# ------------------------------------------------------------------------------
    * Browse artist photos, album covers 
    * Music collection database (SQLite 3)
    * 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 audio engine)
    * Support load/save playlist file (m3u, pls, xspf)
    * Play radio stream (tunein, dirble, radionomy,...)
    * Mp3Gain tag support for volume normalization
    * Contextual info & cover art download (lastfm, echonest, musicbrainz)
    * Supports scrobbling to Last.fm
    * 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-project.org
    * QJson 0.7.1                  - http://qjson.sourceforge.net/
    * TagLib 1.6.2                 - http://developer.kde.org/~wheeler/taglib.html
    * htmlcxx                      - http://htmlcxx.sourceforge.net/
    
Audio engine dependencies:  
    You can choose to use yarock with phonon, vlc and/or mpv audio system
    * Phonon 4.6.0  (default)      - http://phonon.kde.org/
    * Libvlc                       - http://www.videolan.org/vlc/libvlc.html
    * Libmpv                       - http://mpv.io/


# ------------------------------------------------------------------------------
                              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 libhtmlcxx-dev

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

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

Phonon
------
   By default, 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
     
     
Alternate Audio engine 
----------------------
   You can build yarock with alternate audio engine (phonon is the default one)
   If you want to disable phonon just use -DENABLE_PHONON=OFF as cmake option

   For vlc audio engine
        $ mkdir build && cd build
        $ cmake ..  -DENABLE_VLC=ON
        $ make
        $ make install (as root)
   
   For mpv audio engine
        $ mkdir build && cd build
        $ cmake ..  -DENABLE_MPV=ON
        $ make
        $ make install (as root)

       
# ------------------------------------------------------------------------------
                               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-2015 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/>.

