
 Auralquiz - Quiz game about your music
 Copyright 2011-2012 JanKusanagi <janjabber@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 2 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, write to the
   Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA .

==============================================================================


Auralquiz analyzes the music files contained in selected folders, and creates
a quiz about them, using the information stored in their tags (Title and Artist).
It is important that the music files are correctly tagged.

In normal mode, the player is presented with a question and 4 buttons to answer.
A small clip from one of the music files is played, and the player has a few seconds
to answer by clicking the correct button, or pressing 1, 2, 3 or 4 in the keyboard.

In the highest difficulty level, instead of having the buttons, the player must
type the answer. Symbols like "!", "-", "." etc are filtered out, and it's not
case sensitive, so it's a little easier to answer correctly.


Auralquiz is based on Qt, Phonon, and TagLib, which are the
main requirements to compile.

The .qm translation files will be included in the binary as resources,
so there's no need to copy them anywhere in the filesystem afterwards.


According to my testing, the Phonon xine-backend works better than the others for this.
Phonon-vlc-backend works great too. Phonon-gstreamer-backend seems to work ok now,
but I've seen it hang sometimes. YMMV depending on Phonon version, etc.


==============================================================================


Compiling:

From Auralquiz main directory, where Auralquiz.pro is located:

        mkdir build			# create a clean directory for the build
        cd build			# go into it
        qmake ..			# ask Qmake to generate a Makefile
        make				# run Make to compile the project


That should do it.


Dependencies:
You'll need Qmake and the qt-devel, phonon-devel and taglib-devel packages.

- Debian (probably the derivatives too): libqt4-dev, libphonon-dev, libtag1-dev.
- Mageia (probably Mandriva too): libqt4-devel, phonon-devel, libtaglib-devel.
- openSuse: libqt4-devel, phonon-devel, libtag-devel.


You might also need to install qt4-qmake, if your distribution does not include
it with the qt-devel package (Debian, for instance).


If you run Auralquiz in a non-KDE environment, like Gnome or XFCE, you'll probably
need to install, besides Qt and Phonon, one Phonon-backend, like phonon-backend-xine,
phonon-backend-vlc or phonon-backend-gstreamer.


The language files, icon and images will be embedded into the binary
upon compilation, so there's no need to keep them afterwards.


Visit http://jancoding.wordpress.com/auralquiz for more information.

Get the latest source from http://gitorious.org/auralquiz
