Apollo Installation
-------------------

This is the INSTALL file for Apollo:  http://www.apolloplayer.org


Requirements
------------

Apollo requires Qt 2.x by Troll Tech, but will also work with Qt 3.x. You can
get Qt from http://www.trolltech.com. Note that if you run KDE 2 or later, Qt
2.x is already installed.

In order to function, Apollo requires mpg123 to be in your path. mpg123 can be
obtained from http://www.mpg123.com.

Apollo makes use of id3lib if it's installed. Version 3.8.0-pre2 or newer is
required. You can get id3lib from http://id3lib.sf.net. Please not that
3.8.0-pre2 has two bugs that affect Apollo:

 - it gets a random track number in some cases when there is no track
   number
 - it uses id3v1 tags instead of id3v2 when both are present

Apollo can also be built with the STL libraries, it's however no longer
required. If you wish to build it with STL you need to make sure that you have a
properly working version available, the configure script mentioned below takes
care of testing this. A sufficient STL version is most likely already installed
on your system. However, a few systems may have an old STL version installed and
needs to be upgraded in order for Apollo to work. You can get STL from
http://www.stlport.org.

Compilation requires TMake for Makefile creation. If you use the configure
script and get a message telling you that TMake was not found or if you see a
line saying 'tmake: command not found' during compilation you must download
TMake. You can get TMake from Troll Tech's web page at:

 http://www.trolltech.com/products/download/freebies/tmake.html

Note that with Qt 3.x, TMake was replaced with QMake. QMake is fully compatible
with TMake.

If you run KDE you might want to enable the KDE support in Apollo, this means
enabling some global hot keys as well as icon tray support. This is also
detected by configure.

We recommend using the precompiled binaries found at:

 http://download.apolloplayer.org


Compilation
-----------

Before compilation can be started the configure script needs to be run. It takes
care of analyzing your system for available components and creates a Makefile.
If the system does not have the requirements it prints out the missing part and
exits without making the Makefile.

You can also turn on and off certain features with the configure script. You
start the script with

 ./configure.sh

or, to see a list of options:

 ./configure.sh --help

In the directory in which this file resides, there should be a Makefile.
Depending on the operating system you use, you may have have to use a different
'make' command. Below are the instructions for the operating systems tested.
Please let us know if you try this on a different operating system.

For Linux, type:

 make

For FreeBSD, type:

 gmake

The Apollo binary will be made.


Troubleshooting the Compilation
-------------------------------

Apollo is developed and tested on Red Hat Linux, but any Linux distribution
should work. Apollo should compile fine without *ANY* error or warning. Please
report to us if you get warnings or errors. See README file for instructions.

Apollo is likely, however, to work on other unices and you're encouraged to try.
Apollo has been reported to work on FreeBSD, although you may have to define the
QTDIR environment variable. It will typically be set to:

 QTDIR=/usr/X11R6

although it depends where Qt is located on your system.

Please let us know how this works out (see README file for contact
instructions). If you cannot get it to compile, and you believe it is a trouble
with the Makefile, you can try to get TMake from:

http://www.trolltech.com/products/download/freebies/tmake.html

TMake is the tool we use to generate Makefiles. One of its goals is exactly to
properly generate Makefiles for various platforms, and your platform is likely
to be supported. Recreate the Makefile like this:

 tmake apollo.pro -o Makefile

and then type:

 make

(or gmake, see above) to see if the new Makefile works.

Note that TMake was replaced with QMake in Qt 3. QMake is fully compatible with
TMake. Generate a Makefile like this:

 qmake apollo.pro

If Apollo fails to compile and you believe it's a problem with the source code,
please let us know. Again, see the README file for contact instructions.


Installation
------------

Installation can be done with either the provided installation script or
manually. The installation is trivial, so if the installation script does not
work, which may be the case for certain platforms, please install manually.

Script:
  Simply enter:

   ./install.sh

  to start the installation.  To find out about other install options,
  type

   ./install.sh --help

Manually:
  Copying the file to your path. Typically, /usr/local/bin
  will work. Type:

   install -m 755 apollo /usr/local/bin

If you for some strange reason want to uninstall Apollo, you can use the
uninstall script by entering:

 ./uninstall.sh

As always you type:

 ./uninstall.sh --help

to find out about the other uninstall options.


KDE Installation
----------------

Those of you running KDE might want to add a menu item for Apollo. Luckily for
you, the install script mentioned above can do this too. Simply enter:

 ./install.sh --with-kde

and it should install the necessary icons and setup a menu item.

If you have the KDE icon RPM you need to tell RPM where you have KDE installed
by supplying a directory to RPM program. Enter something like (replace the
filename to match whatever it is you're trying to install):

 rpm -ivh --prefix=$KDEDIR apollo-KDE-1.1.i386.rpm

to install it properly. This assumes that the enviroment variable KDEDIR is
properly setup.


Running
-------

Once Apollo is installed simply type

 apollo

to run it. Alternatively, you can run it from where it is, which should be in
the same directory as this file. Simply type

 ./apollo


Problems?
---------

If you have problems, take a moment to read the README file which is in the same
directory as this file.


 - The Apollo Team




