
 Auralquiz - Quiz game about your music
 Copyright 2011-2025  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 5.10 or newer, or Qt 6.0 or newer.
 - Phonon for Qt 5 or Qt 6 accordingly.
 - At least one Phonon Backend. The VLC backend is recommended.
   (usually phonon4qt5-backend-vlc, phonon4qt6-backend-vlc, phonon-backend-vlc,
    or similar)
 - TagLib 2.x or 1.x.



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

You'll need qmake and the qt-devel (>=5.10 or >=6.0), phonon-devel and
taglib-devel packages. Qmake might be included in the Qt development packages,
or it might be a separate package.
Either TagLib 1.x or 2.x should work, but you might run into trouble if devel
packages for both are installed.


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

  - Mageia (probably in Mandriva and ROSA, too):
      Qt5: lib64phonon4qt5-devel (pulls in Qt5 devel stuff), lib64taglib-devel
      Qt6: lib64phonon4qt6-devel (pulls in Qt6 devel stuff), lib64taglib-devel

      ** Note: For the i586 architechture, remove the "64" from the package
               names, such as libtaglib-devel.

    >> Build tools: gcc-c++, make



  - Debian (and probably in its derivatives too):
      Qt5: qtbase5-dev, libphonon4qt5-dev, libtag-dev
      Qt6: qt6-base-dev, libphonon5qt6-dev, libtag-dev

    >> Build tools: build-essential, g++, qt5-qmake5/qmake6



  - Fedora:
      Qt5: qt5-qtbase-devel, phonon-qt5-devel, taglib-devel
      Qt6: qt6-qtbase-devel, phonon-qt6-devel, taglib-devel



  - openSUSE:
      Qt5: libqt5-qtbase-devel, phonon4qt5-devel, libtag-devel
      Qt6: qt6-base-devel, phonon-qt6-devel, libtag-devel



  - Archlinux and Parabola (runtime deps include build-time deps):
      qt6-base, phonon-qt6, taglib

    >> Build tools: base-devel


You might also need to install qt5-qmake/qt6-qmake (or similar), if your
distribution does not include it with the Qt development package.
Most necessary build tools are listed above.



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

[*]you might need to use the command 'qmake-qt5', 'qmake6' or 'qmake-qt6' instead!


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,
LXQt or Xfce, you'll probably need to install, besides Qt and Phonon, one of
Phonon's backends, like phonon-backend-vlc or phonon-backend-gstreamer.
The Phonon backend you use, must be built for Qt 5 or Qt 6, matching your build.

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
