andre@0: /** @file INSTALL
andre@0: @brief Installation Instructions
andre@0: *******************************
andre@0: 
andre@0: For Debian based GNU / Linux
andre@0: ============================
andre@0: Tested development platform: Ubuntu 14.4 amd64.
andre@0: 
andre@0: Build dependencies are:
andre@0:     build-essential cmake libqt5core5a qttools5-dev-tools qt5-default \
andre@0:     qtbase-dev qtbase5-dev-tools qttools5-dev inkscape
andre@0: 
andre@0: 
andre@0: This document expects the following setup for build and installation.
andre@0: It is recommended to set a custom installation prefix to avoid root
andre@0: privileges.
andre@0: 
andre@0:     export CUSTOM_PREFIX=<Prefix of your choice (default /usr)>
andre@0:     mkdir -p $CUSTOM_PREFIX/bin
andre@0:     export PATH=$CUSTOM_PREFIX/bin:$PATH
andre@0: 
andre@0: Building the Software:
andre@0:     cd <PATH_TO_REPO>
andre@0:     mkdir build-native
andre@0:     cd build-native
andre@0:     cmake .. -DCMAKE_PREFIX_PATH=$CUSTOM_PREFIX
andre@0: 
andre@0: For Microsoft Windows
andre@0: =====================
andre@0: The Windows variant should be cross compiled from a Debian based GNU/Linux
andre@0: system. The minimum requirement is Debian stable.
andre@0: 
andre@0: Tested development platform is Ubuntu 14.4
andre@0: 
andre@0: Dependencies on the Host system:
andre@0: 
andre@0:     apt-get install git autoconf automake bash bison bzip2 \
andre@0:     cmake flex gettext git g++ intltool \
andre@0:     libffi-dev libtool libltdl-dev libssl-dev \
andre@0:     libxml-parser-perl make openssl patch perl \
andre@0:     pkg-config scons sed unzip curl xz-utils autopoint \
andre@0:     gperf
andre@0: 
andre@0: Build the windows binaries:
andre@0: 
andre@0:     MXEPATH=$CUSTOM_PREFIX/win
andre@0:     git clone https://github.com/Intevation/mxe.git $MXEPATH
andre@0:     cd $MXEPATH
andre@0:     git checkout replay-it
andre@0:     echo "MXE_TARGETS := i686-w64-mingw32.static" > settings.mk
andre@0:     make qtbase
andre@0: 
andre@0: Add CMAKE_STRIP to the toolchain file:
andre@0: 
andre@0:     echo "set(CMAKE_STRIP $MXEPATH/usr/bin/i686-w64-mingw32.static-strip)" >> \
andre@0:         "$MXEPATH/usr/i686-w64-mingw32.static/share/cmake/mxe-conf.cmake"
andre@0: 
andre@0: Compile the software:
andre@0: 
andre@0:     cd repo
andre@0:     mkdir build-windows
andre@0:     cd build-windows
andre@0:     MXETARGET=$MXEPATH/usr/i686-w64-mingw32.static/
andre@0:     cmake .. \
andre@0:         -DCMAKE_PREFIX_PATH="$MXETARGET/qt5;$MXETARGET;" \
andre@0:         -DCMAKE_TOOLCHAIN_FILE="$MXETARGET/share/cmake/mxe-conf.cmake" \
andre@0:         -DCMAKE_VERBOSE_MAKEFILE=True
andre@0: */