[PATCH 1 of 3] Fix INSTALL file so that it can be included in doxygen

[Wald Commits]

# HG changeset patch
# User Andre Heinecke <andre.heinecke at intevation.de>
# Date 1411659393 -7200
# Node ID eb4d7337edd7d152bf08b36e650fcedd13d0ccbd
# Parent  9a482182f80ffdc95d98fd27c24eee6e04812735
Fix INSTALL file so that it can be included in doxygen

diff -r 9a482182f80f -r eb4d7337edd7 INSTALL
--- a/INSTALL	Thu Sep 25 15:57:25 2014 +0200
+++ b/INSTALL	Thu Sep 25 17:36:33 2014 +0200
@@ -1,4 +1,5 @@
-Installation Instructions
+/** @file INSTALL
+ at brief Installation Instructions
 *************************
 
 For Debian based GNU / Linux
@@ -16,7 +17,6 @@
     export PATH=$YOURPREFIX/bin:$PATH
 
     curl https://download.qt-project.org/official_releases/qt/5.3/5.3.2/single/qt-everywhere-opensource-src-5.3.2.tar.xz.mirrorlist | grep SHA-256
-
 7f5bf93344cb57bac374ea4a32c8eda87f1357f998f14278e717cf84d0289bf0
 
     http://qt-mirror.dannhauer.de/official_releases/qt/5.3/5.3.2/single/qt-everywhere-opensource-src-5.3.2.tar.xz
@@ -90,8 +90,9 @@
     --without-zlib
     make && make install
 
-To compile the software you can use plain cmake. An out of source build is
-highly suggested. For build options see CMakeList.txt
+To compile the software you can use plain cmake.
+An out of source build is highly suggested.
+For build options see CMakeList.txt
 
     cd trustbridge
     hg clone https://wald.intevation.org/hg/trustbridge/nss-cmake-static
@@ -103,18 +104,20 @@
 I386
 ====
 Install dependencies (list might be incomplete)
+
     apt-get install libx32stdc++-4.8-dev libc6:i386 g++-4.8-multilib \
-   libxcb1:i386 libxcb1-dev:i386 libx11-xcb1:i386 libx11-xcb-dev:i386 libxcb-keysyms1:i386 \
-   libxcb-keysyms1-dev:i386 libxcb-image0:i386 libxcb-image0-dev:i386 \
-   libxcb-shm0:i386 libxcb-shm0-dev:i386 libxcb-icccm4:i386 \
-   libxcb-icccm4-dev:i386 libxcb-sync-dev:i386 \
-   libxcb-render-util0:i386 libxcb-render-util0-dev:i386 \
-   libxcb-xfixes0-dev:i386 libxrender-dev:i386 libxcb-shape0-dev:i386 \
-   libxcb-randr0-dev:i386 libxcb-glx0-dev:i386 libdbus-1-dev:i386 \
-   libsm-dev:i386 libnss3-dev:i386
+     libxcb1:i386 libxcb1-dev:i386 libx11-xcb1:i386 libx11-xcb-dev:i386 libxcb-keysyms1:i386 \
+     libxcb-keysyms1-dev:i386 libxcb-image0:i386 libxcb-image0-dev:i386 \
+     libxcb-shm0:i386 libxcb-shm0-dev:i386 libxcb-icccm4:i386 \
+     libxcb-icccm4-dev:i386 libxcb-sync-dev:i386 \
+     libxcb-render-util0:i386 libxcb-render-util0-dev:i386 \
+     libxcb-xfixes0-dev:i386 libxrender-dev:i386 libxcb-shape0-dev:i386 \
+     libxcb-randr0-dev:i386 libxcb-glx0-dev:i386 libdbus-1-dev:i386 \
+     libsm-dev:i386 libnss3-dev:i386
 
 Create a new directory for qt. As qt has to build in source you need a different
-directory.
+directory:
+
     mkdir i386
     cd i386
     tar -xf ../qt-everywhere-opensource-src-5.3.2.tar.xz
@@ -130,7 +133,8 @@
     nice make -j`nproc` && \
     make install
 
-Switch back to the polarssl directory
+Switch back to the polarssl directory:
+
     cd ../../../polarssl-1.3.8/
     mkdir build-i386
     cd build-i386
@@ -140,7 +144,8 @@
     nice make -j`nproc` && \
     make install
 
-Change to the curl directory
+Change to the curl directory:
+
     cd ../../curl-7.38.0/
     mkdir build-i386
     cd build-i386
@@ -190,13 +195,13 @@
 
     wget http://downloads.sourceforge.net/project/osslsigncode/osslsigncode/osslsigncode-1.7.1.tar.gz
     sha256sum osslsigncode-1.7.1.tar.gz
-# f9a8cdb38b9c309326764ebc937cba1523a3a751a7ab05df3ecc99d18ae466c9
+f9a8cdb38b9c309326764ebc937cba1523a3a751a7ab05df3ecc99d18ae466c9
     tar -xf osslsigncode-1.7.1.tar.gz
     cd osslsigncode-1.7.1
     ./configure --without-curl --prefix=$YOURPREFIX
     make && make install
 
-    # for a windows binary (optional)
+#for a windows binary (optional):
     OPENSSL_CFLAGS=-I$MXETARGET/include OPENSSL_LIBS="-L$MXETARGET/lib -lcrypto -lz -lgdi32" ./configure --without-curl --host=i686-w64-mingw32 --prefix=$MXETARGET
 
 For Microsoft Windows
@@ -206,7 +211,8 @@
 Tested development platform: Ubuntu 13.10.
 
 Dependencies on the Host system:
-    git autoconf automake bash bison bzip2 \
+
+    apt-get install git autoconf automake bash bison bzip2 \
     cmake flex gettext git g++ intltool \
     libffi-dev libtool libltdl-dev libssl-dev \
     libxml-parser-perl make openssl patch perl \
@@ -214,6 +220,7 @@
     gperf
 
 Build the windows binaries:
+
     MXEPATH=$YOURPREFIX/win
     git clone https://github.com/Intevation/mxe.git $MXEPATH
     cd $MXEPATH
@@ -221,19 +228,25 @@
     echo "MXE_TARGETS := i686-w64-mingw32.static" > settings.mk
     make polarssl
     make qtbase
-(optional) make curl
+
+(optional)
+
+    make curl
 
 Add CMAKE_STRIP to the toolchain file:
+
     echo "set(CMAKE_STRIP $MXEPATH/usr/bin/i686-w64-mingw32.static-strip)" >> \
         "$MXEPATH/usr/i686-w64-mingw32.static/share/cmake/mxe-conf.cmake"
 
 Workaround Qt CMake Bugs:
+
     find $MXEPATH/usr/i686-w64-mingw32.static/qt5/lib/cmake -name \*.cmake | \
         xargs sed -i 's/\/\([a-z]*\)\.lib/\/lib\1\.a/g'
     sed -i 's/^_qt5gui_find_extra_libs.*//' \
         $MXEPATH/usr/i686-w64-mingw32.static/qt5/lib/cmake/Qt5Gui/Qt5GuiConfigExtras.cmake
 
 Compile the software:
+
     cd trustbridge
     mkdir build-windows
     cd build-windows
@@ -249,3 +262,4 @@
 packages:
 
     apt-get install nsis wine sharutils
+*/