1) COMPILING FOR LINUX/UNIX/WINDOWS/PPC et al
===============================================================================

Zhu3D was designed for Linux, but as it is using the powerful Qt-Framework it
can be compiled under different Unices, Windows or Mac OS X too. To make the
compilation process as easy as possible, dependencies are reduced to an
absolute minimum.

A declared goal of Zhu3D is to compile without any single compiler warning
under different systems and compilers. If you face warnings, give me a short
notice please.

What is needed:

    HW-OpenGL 1.4 or later or at least a software-implementation like Mesa
    Qt 4.3.0 or later; common Linux users should have installed this yet
    GCC 3.4.0 or later; respectively MinGW for Windows

The newest version of Qt4 you will find under www.trolltech.com. If everything
is prepared, first untar the package and generate your makefile, then compile
and clean up finally:

    1) Unpacking the tarball and change to the new zhu-directory:

    tar zxvf zhu3d-4.2.6.tar.gz
    cd zhu3d-4.2.6

    2) Ready to compile (and clean up) now:

    qmake
    make
    make clean

HINT: Of course you have to use the "right" qmake for Qt4.x and not some
version from the 3.x-series, which may be installed on many machines too.
When you face troubles, check your version with qmake --version and - if
necessary - use the correct one instead.

SSE3: When you want to enable SSE3, switch it on in the file zhu3d.pro before
you go on with qmake, make and make clean. Look at zhu3d.pro for details.

ICC NOTES: For Intel ICC compilers use "qmake -spec linux-icc" instead of
qmake. Look at the files intel-icc.txt and zhu3d.pro for more details.


2) TESTED PLATFORMS
===============================================================================

To ensure release quality and a broad range of compatibility, Zhu3D was tested
on miscellaneous platforms and compilers. Currently these are:

OS                  Bit  CPU         Qt4    Compiler     Graphic card
-------------------------------------------------------------------------------
openSUSE 12.3/KDE4  64   Core 2 Duo  4.8.4  gcc 4.7.2    Nvidia 210
openSUSE 12.3/KDE4  64   Core 2 Duo  4.8.4  icc 13.0.0   Nvidia 210
Mandriva 2010.2     32   AMD Sempron 4.7.3  gcc 4.4.3    AMD/ATI 1100 Xpress
openSUSE 11.4/KDE4  64   Core 2 Duo  4.7.1  icc 12.0.3   Nvidia 8600 GT
openSUSE 11.4/KDE4  64   Core 2 Duo  4.7.1  gcc 4.5.1    Nvidia 8600 GT
openSUSE 11.2/KDE4  64   Core 2 Duo  4.7.0  gcc 4.4.1    Nvidia 8600 GT
openSUSE 11.2/KDE4  64   Core 2 Duo  4.7.0  icc 11.1     Nvidia 8600 GT
openSUSE 11.0/KDE3  64   Core 2 Duo  4.5.2  gcc 4.3.1    Nvidia 8600 GT
openSUSE 11.0/KDE3  64   Core 2 Duo  4.5.2  icc 11.1     Nvidia 8600 GT
openSUSE 11.0/KDE3  64   Core 2 Duo  4.5.2  icc 11.0     Nvidia 8600 GT
Gentoo/KDE4         64   Core 2 Duo  4.5.0  gcc 4.1.2    Nvidia 8600 GT
Ubuntu 8.10         64   Core 2 Duo  4.4.3  gcc 4.3.2    Intel GMA X4500MHD
Kubuntu 8.10/KDE4   64   Core 2 Duo  4.4.3  gcc 4.3.1    AMD/ATI 1200 XPRESS
openSUSE 11.1       32   Core 2 Duo  4.4.3  gcc 4.3.2    Nvidia 9750 GT
Arch Linux          32   Pentium 4   4.4.3  gcc 4.3.2    Nvidia 6200
Windows XP/SP2      32   Athlon XP   4.4.3  mingw 3.4.2  AMD/ATI 9600 XT
Windows Vista       32   Phenom X3   4.4.3  mingw 3.4.2  Nvidia 9600 GS
SUSE 10.0           32   Athlon XP   4.3.1  icc 10.1     AMD/ATI 9600 XT
SUSE 10.0           32   Athlon XP   4.3.1  gcc 4.0.2    AMD/ATI 9600 XT

Quite sure there are more tested platforms as packagers would respond in case
of failures. If you have a very uncommon or completely uncovered platform, you
may act as additional tester. Please contact zhu3d (at) aon.at for this.

Just for curiosity I tested Zhu3D on virtual machines. On Qemu 0.9.1 it runs slow
due to missing hardware-OpenGL, but near to perfect. Wine 1.1.26 shows no major
speed drawback's and is near to perfect too.


3) PACKAGING/TAILORING
===============================================================================

The work-directory as well as the textures need NO write privileges in
any case, because they easily can be redefined within Zhu3D at runtime.
Look at the file zhu3d.pri for more details. There you easily can set a
default Gui for KDE, Gnome, Mac et al too.


4) WINDOWS
===============================================================================

If you fear compiling, there is a precompiled and ready-to-go Zhu3D-package.
Check http://www.sourceforge.net/projects/zhu3d/ for this.

Zhu3D needs no installation and does not touch your system settings. All
settings like languages, general appearance or path settings are done
dynamically at runtime and are remembered within Zhu3D itself.

Compiling by yourself is easy and can be done with a few clicks and commands:

- Download and install latest qt-win-opensource-4.x-mingw.exe
- Download and uncrompress the zhu3d-x.y.z.tar.gz
- Qt4 contains a folder "imageformats". Search this and copy it as a whole
  into the Zhu3D directory

Now the preparations are done and you are ready to compile. Open a commandline
shell, change into the zuh3d-directory and enter:

    qmake
    mingw32-make
    mingw32-make clean

That's all. Copy the newly produced exe into your zhu3d-directory and start. If
you wish, you simply can move your zhu3d-directory wherever you want.
