
 Auralquiz - Quiz game about your music
 Copyright 2011-2017  JanKusanagi JRR <jancoding@gmx.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.

   Or visit http://www.gnu.org/licenses/

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


These are some basic instructions on how to build Auralquiz from source, in
case you don't have precompiled packages available for your operating system.

See https://jancoding.wordpress.com/auralquiz for info on package availability.



General runtime dependencies (check carefully!)
===============================================================================

 - Qt 4.6.x (or a newer 4.x) or 5.x.
 - Phonon (for Qt 4 or Qt 5, matching your version of Qt).
 - At least one Phonon Backend. I recommend the VLC backend.
   (usually phonon-backend-vlc, and phonon4qt5-backend-vlc for Qt5, or similar)



Dependencies for building
===============================================================================

You'll need qmake and the qt-devel (>=4.6), phonon-devel and taglib-devel
packages. Qmake might be included in the Qt development packages, or it might
be a separate package.

These are the names of the packages for the build dependencies
in some GNU/Linux distributions:

  - Mageia (probably in Mandriva and ROSA, too):
      Qt 4: libqt4-devel, phonon-devel, libtaglib-devel.
      Qt 5: phonon4qt5-devel (pulls in Qt5 devel stuff), libtaglib-devel.

    ** Note: In x86_64 arch, "lib" packages start with "lib64",
             such as lib64taglib-devel.

  - Debian (and probably in its derivatives too):
      Qt 4: libqt4-dev, libphonon-dev, libtag1-dev.
      Qt 5: qt5-default, libphonon4qt5-dev, libtag1-dev.

  - Fedora:
      Qt 4: qt-devel, phonon-devel, taglib-devel.
      Qt 5: qt5-qtbase-devel, phonon-qt5-devel, taglib-devel.

  - openSuse:
      Qt 4: libqt4-devel, phonon-devel, libtag-devel.
      Qt 5: libqt5-qtbase-devel, phonon4qt5-devel, libtag-devel.

  - Archlinux (runtime dependencies include build-time dependencies):
      Qt 4: qt4, phonon-qt4.
      Qt 5: qt5-base, phonon-qt5.


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



Build process
===============================================================================

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

[*]if you want to build with Qt 4, and have the command 'qmake-qt4' available,
   use that instead of 'qmake'!


That should do it.

There is no installation target, just run the resulting "auralquiz" binary.


If you run Auralquiz in a desktop environment other than KDE Plasma, like Gnome
or Xfce, you'll need to install, besides Qt and Phonon, one Phonon-backend,
like phonon-backend-xine, phonon-backend-vlc or phonon-backend-gstreamer.
The Phonon backend you use, must be built for the same major version of Qt you
are using (eg. Qt 4 or Qt 5).

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 https://gitlab.com/auralquiz/auralquiz-dev
