/*! \page buildingOpenFlipper Building OpenFlipper
*
* \section dependencies Dependencies
*
* OpenFlipper is developed on top of the Qt framework. This framework provides
* easy cross platform development. Therefore an installed version of qt with
* at least version 4.5 is required. As the framework depends on qt we use the
* qt make tool qmake to build OpenFlipper.
*
* \section reqlibs Required libraries
*
* - Qt >= 4.5 ( http://www.qtsoftware.com/downloads )
* - OpenGL ( http://www.opengl.org )
* - GLUT ( http://glew.sourceforge.net )
* - GLEW ( http://www.opengl.org/resources/libraries/glut/ )
* - freetype2 ( optional http://www.freetype.org/freetype2/index.html )
* - ftgl ( optional http://sourceforge.net/projects/ftgl/)
*
*
* \section bs Build System
* The build system uses either cmake or qmake to generate all makefiles.
* Since v1.0 RC2 it is recommended to use cmake as primary build system.
* Nevertheless qmake will still be supported, too. In this section we offer
* descriptions for both build systems.
*
* - \ref build_cmake
* - \ref build_qmake
*
* \section build_cmake Building OpenFlipper using Cmake
*
* For the following section CMake >= 2.6.x has to be installed.
* In the toplevel directory of OpenFlipper is a CMakeLists.txt
* file that specifies the build configuration and targets. In most cases
* this file should be left untouched. Additional functions and environment
* settings are to be found in the cmake directory in the toplevel folder.
* See following subsections for information on how to build OpenFlipper
* for your specific operating system.
*
* \subsection cmake_blinux Building OpenFlipper under Linux
*
*
* - First install the required libraries (see above)
* - Extract the source code or get it via svn:
* svn co http://www-i8.informatik.rwth-aachen.de/svnrepo/OpenFlipper/branches/Free OpenFlipper
* - Create a build directory (e.g. build) in the toplevel directory:
mkdir build
* - Change to the newly created directory
cd build
and type cmake ..
* - Now call make to build OpenFlipper
*
*
* The created application (binaries, libs and shared files) are to be found in the Build
* directory.
*
* \subsection cmake_bwin Building OpenFlipper under Windows
*
*
* - Get Visual Studio 2008
* - Get and Install Qt ( >= 4.5 )
* - Set the QTDIR Variable to your Qt Installation directory
* - Extract OpenFlipper source code.
* - Get all required libraries and install them ( including headers! ).
* - Create a directory named e.g. build in the toplevel directory of OpenFlipper.
* - Open Visual Studio 2008 and go to Tools->Visual Studio command prompt
* - Go to the newly created build directory within OpenFlipper's top level directory.
* - Type cmake ..
* - You can now find a Visual Studio project file in the build directory
* - Now you can build OpenFlipper from within Visual Studio using the newly created project file.
*
*
* \subsection cmake_bmacos Building OpenFlipper under MacOS X
*
*
* - First install the required libraries (see above)
* - Extract the source code or get it via svn:
* svn co http://www-i8.informatik.rwth-aachen.de/svnrepo/OpenFlipper/branches/Free OpenFlipper
* - Create a build directory (e.g. build) in the toplevel directory:
mkdir build
* - Change to the newly created directory
cd build
and type cmake ..
* - Now call make to build OpenFlipper
*
*
* The created application bundle (that contains binaries, libs and shared files) is to be found in the Build
* directory.
*
* \section build_qmake Building OpenFlipper using Qmake
*
* In the toplevel directory of OpenFlipper is a .qmake.cache file
* which defines the variable TOPLEVEL available in all qmake project files.
* This file also includes our qmake configuration in the
* qmake subdirectory. The files in this directory control the build process for the
* core as well as for the plugins. Library dependencies are specified in the project
* files by calling functions which will check for the requested libs. These functions are
* defined in architecture dependend files under qmake/packages . If you get errors
* about libraries not found, please change the paths in these configuration files.
*
* \subsection blinux Building OpenFlipper under Linux
*
* - First extract the source code or get it via svn:
* svn co http://www-i8.informatik.rwth-aachen.de/svnrepo/OpenFlipper/branches/Free OpenFlipper
* - Get all required libraries and install them ( including headers! ).
* - Go to the qmake/packages directory and change the packages. files to match the library paths
* - In the toplevel Directory call qmake ( It should be the qmake Version for qt4! Debian uses for example qmake-qt4 )
* This will build the Makefiles
* - Now call make to build OpenFlipper
*
*
* After building OpenFlipper the Core can be found in the OpenFlipper/__Release.
* The plugins are build in the OpenFlipper/Plugins directory.
*
* \subsection bwin Building OpenFlipper under Windows
*
*
* - Get Visual Studio 2008
* - Get and Install Qt ( >= 4.5 )
* - Set the QTDIR Variable to your Qt Installation directory
* - Extract OpenFlipper source code.
* - Get all required libraries and install them ( including headers! ).
* - Open
OpenMesh\qmake\packages\packages.Windows
in a text editor and change header and library paths
* such that they match the ones installed (see comments to find path entries).
* - Open Visual Studio 2008 and go to Tools->Visual Studio command prompt
* - Go to the toplevel OpenFlipper directory
* - Call qmake -spec win32-msvc2008 -r ( It should be the qmake Version for qt4! )
This will build Visual Studio project files and a solution file.
* - Open the OpenFlipper.sln file in the toplevel directory.
* - Now you can build OpenFlipper from within Visual Studio.
*
*
* After building OpenFlipper the Core can be found in the OpenFlipper/Windows__Release.
* The plugins are build in the OpenFlipper/Plugins directory.
*
* \subsection bmac Building OpenFlipper under MacOS X
*
* - Download and install latest Xcode Tools (including gcc)
* - Download and install Qt (>= 4.5)
* - Install required libraries (using a portage system like MacPorts is recommended)
* - Download and extract OpenFlipper sources
* (or download via svn: svn co http://www-i8.informatik.rwth-aachen.de/svnrepo/OpenFlipper/branches/Free OpenFlipper
)
* - Adapt library and header paths in $OpenFlipper/qmake/packages/packages.Darwin
* - Go into OpenFlipper's root directory and type qmake -spec macx-g++
* - Type make qmake_all
to build all Makefiles
* - Now type make release
to build OpenFlipper
* - Execute Build_Darwin_Bundle.sh
in OpenFlipper's root directory to correct install_name paths within the application bundle
*
* IMPORTANT: If you don't see any icons in the application you probably might have
* forgot the last step which manages to copy the Icons, Textures, Shaders and Fonts
* directories into the application bundle's resource folder. It further fixes library header paths
* such that the application bundle can be copied anywhere without getting trouble
* with missing libraries.
*
* After building OpenFlipper the application bundle can be found in OpenFlipper/Darwin__Release.
* The plugins are build into the application bundle's Resources directory.
*
* Note: If you don't want qmake to build OpenFlipper as MacOS X application bundle
* you have to uncomment line
# CONFIG -= app_bundle # Do not build a framework bundle
* in file $OpenFlipper/qmake/all.include
.
*/