# ------------------------------------------------------------------------------
                              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 (icecast, shoutcast, user stream files)
      * Mp3Gain tag support for volume normalization
      * Cover art download (Last.fm/discogs services)
      * Last Fm scrobbler
      * Command line interface, Mpris interface
      * Clean and simple user interface 
      * No GNOME or KDE dependancies
      
# ------------------------------------------------------------------------------
                              Dependencies
# ------------------------------------------------------------------------------
   - Qt >= 4.7.0        - http://qt.nokia.com/
   - TagLib >= 1.6.2    - http://developer.kde.org/~wheeler/taglib.html
   - C++ Boost library (libboost-dev under ubuntu family linux)
   - standard C++ library

On a Debian or Ubuntu system type:
   sudo apt-get install build-essential qt4-dev-tools libphonon-dev libtag1-dev libqt4-sql-sqlite

Third party libraries that I ship with the source (no need to install):
   libechonest 1.2.0 - http://projects.kde.org/projects/playground/libs/libechonest/

# ------------------------------------------------------------------------------
                              Build instructions
# ------------------------------------------------------------------------------
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


Compiling
----------
   $ qmake (qmake-qt4 on fedora 15)
   $ make
  
Install on Linux
----------------
   $ sudo make install

Running
------------
   using local directory
   $ ./build/target/Yarock

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

