/*! \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 * * * \section bs Build System * The build system uses cmake to generate all makefiles. * Since v1.0 RC2 it is recommended to use cmake as primary build system. * * \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 * * * * To switch between debug and release build, use cmake -DCMAKE_BUILD_TYPE=Debug .. * Change install path: -DCMAKE_INSTALL_PREFIX=[path] * * The created application (binaries, libs and shared files) are to be found in the Build * directory. * * \subsection cmake_bwin Building OpenFlipper under Windows * * * * Note: If you want to build OpenFlipper as release, you have to set the CMAKE_BUILD_TYPE variable to "Release" before configuring * and generating the Visual studio solution file. Choose then build type "Release" in Visual Studio and build the solution. * * \subsection cmake_bmacos Building OpenFlipper under MacOS X * * * * The created application bundle (that contains binaries, libs and shared files) is to be found in the Build * directory. * * \section cmake_plugin Building OpenFlipper Plugins with CMake * * Building plugins with CMake is very simple. The OpenFlipper CMake build system * expects a CMakeLists.txt file in each of the plugin's directories. * So when developing a plugin, just make sure there is a CMakeLists.txt in * your plugin's directory. In this file include the global file plugin.cmake * which specifies the openflipper_plugin() function: * * include(plugin) * * You then have to add the following line which configures the build parameters * of your plugin: * * openflipper_plugin() * * Note: There are several parameters that one can pass to this function. * Usage: * * \include example/cmake_plugin_usage.txt * * For a detailed description of the parameters see the CMake documentation. * For an example of how to build a simple plugin see \ref ex1. * */