building.docu 8.45 KB
 Mike Kremer committed Apr 22, 2009 1 /*! \page buildingOpenFlipper Building OpenFlipper  Mike Kremer committed Apr 29, 2009 2  *  Mike Kremer committed Apr 22, 2009 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18  * \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 *
*
• *
• 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/)
• *
 Mike Kremer committed Apr 29, 2009 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92  * * \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.  Mike Kremer committed Apr 22, 2009 93  *  Mike Kremer committed Apr 29, 2009 94  * \subsection blinux Building OpenFlipper under Linux  Mike Kremer committed Apr 22, 2009 95 96 97 98 99 100  *
*
• 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 )  Mike Kremer committed Apr 29, 2009 101  * This will build the Makefiles
•  Mike Kremer committed Apr 22, 2009 102 103 104 105 106 107  *
• 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. *  Mike Kremer committed Apr 29, 2009 108  * \subsection bwin Building OpenFlipper under Windows  Mike Kremer committed Apr 22, 2009 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128  * *
*
• 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. *  Mike Kremer committed Apr 29, 2009 129  * \subsection bmac Building OpenFlipper under MacOS X  Mike Kremer committed Apr 22, 2009 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152  * * - 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  Mike Kremer committed Apr 23, 2009 153  * in file$OpenFlipper/qmake/all.include.  Mike Kremer committed Apr 22, 2009 154  */