From b832c5fd93f1998938833dee0373222ef72d4401 Mon Sep 17 00:00:00 2001 From: Mike Kremer Date: Mon, 4 May 2009 14:48:44 +0000 Subject: [PATCH] Updated compiling instructions with respect to the new integrated build system support for cmake git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@121 fdac6126-5c0c-442c-9429-916003d36597 --- Doc/misc.docu | 82 +++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 67 insertions(+), 15 deletions(-) diff --git a/Doc/misc.docu b/Doc/misc.docu index d1c20a9d..efe61551 100644 --- a/Doc/misc.docu +++ b/Doc/misc.docu @@ -35,7 +35,7 @@ The following naming conventions are used for the OpenMesh code: \section compilers Tested compilers -%OpenMesh has been tested sucessfully for the following operating +%OpenMesh has been successfully tested for the following operating systems / compilers: @@ -51,13 +51,13 @@ gcc 4.3.x
Microsoft Visual Studio 2008
-
MacOS X
(Panther and Tiger)		 +
MacOS X
(Panther, Tiger and Leopard)		 gcc 4.0
+gcc 4.2
- \section sec_compiling_unix Unix Install the following external libraries / frameworks:

@@ -66,17 +66,56 @@ Install the following external libraries / frameworks:

Qt4http://www.qtsoftware.com/downloads GLEWhttp://glew.sourceforge.net/

-In order to compile and install OpenMesh, enter following commands in OpenMesh's root directory:

+ +\section build_systems Chosing build system + +OpenMesh can be built either using qmake (that already comes along +with the qt framework) or cmake. Since both systems work and will be supported +in future releases, the choice of what build system to use is left to the user. + +\subsection linux_using_cmake Compiling OpenMesh using CMake + +In order to compile OpenMesh, create a directory named e.g. "build" in +OpenMesh's root directory. Change to the newly created directory and type +

+ +cmake ..            ## Generates the appropriate Makefiles
+make                ## Builds the project (use 'make debug' to build debug version)
+
+The application will be found under "Build/bin" in the recently created build folder. +Build also contains the shared objects needed by the application. + +\subsection linux_using_qmake Compiling OpenMesh using QMake + +In order to compile OpenMesh, enter following commands in OpenMesh's root directory:

qmake             ## Generates the appropriate Makefiles
make              ## Builds the project (use 'make debug' to build debug version)

-When using the \c qmake command, make sure to use Qt version 4 (some linux distributions
+Make sure to use Qt version 4 (some linux distributions
use the link \c qmake-qt4 against the executable). \section sec_compiling_windows Windows -Prerequisites:

+\subsection windows_using_cmake Compiling OpenMesh using CMake + +If you want to use cmake to build your Visual Studio 2008 solution file,
+download and install CMake from www.cmake.org.
+(Note: This is not mandatory since there are already VS2008 solution files included in OpenMesh).

+Install the OpenGL Extension Wrangler Library (GLEW) from http://glew.sourceforge.net. +
+
+ + +\subsection windows_using_qmake Compiling OpenMesh using QMake + If you want to use qmake to build your Visual Studio 2008 solution file,
download and install the Qt4 framework from Trolltech.
(Note: This is not mandatory since there are already VS2008 solution files included in OpenMesh).

@@ -93,28 +132,41 @@ for GLEW and GLUT such that they match the installed ones (see comments to find
  • Choose \c Build \c solution from the build menu
    • -\section sec_compiling_macosx MacOSX +\section sec_compiling_macosx MacOS X Download and install the Qt4 framework from Trolltech.
    Because some of the examples depend on the GLEW library, it's recommended to install glew via the darwin portage -system fink.
    -If you have not installed fink yet, follow the instructions given on their site in order to install it.
    +system darwin ports.
    +If you have not installed it yet, follow the instructions given on their site in order to install it.
    Type -sudo fink install glew +sudo port -v install glew -to install glew headers and libraries. ( Fink usually installs header files to \c /sw/include and libraries to \c /sw/lib. )
    +to install glew headers and libraries. ( Darwin ports usually installs header files to \c /usr/local/include and libraries to \c /usr/local/lib. )

    -( If you don't want to use fink and install the libraries manually instead -or via darwin ports-, make sure that
    -the right paths are specified in \c OpenMesh/qmake/packages/packages.Darwin ) + +\subsection mac_using_cmake Compiling OpenMesh using CMake + +If you're using cmake as preferred build system create a directory +named e.g. in OpenMesh's root directory and change to it. +

    + +cmake ..            ## Generates the appropriate Makefiles
    +make                ## Builds the project (use 'make debug' to build debug version)
    +
    +The mac application bundle will be found under "Build" in the recently created build folder. +It automatically contains all needed shared objects (libs, fonts, textures, etc.). + +\subsection mac_using_qmake Compiling OpenMesh using QMake + +Adapt the header paths of at least GLEW (optional freetype, FTGL,...) in file OpenMesh/qmake/packages/packages.Darwin.

    In order to compile and install OpenMesh, open a Terminal window and enter following commands in OpenMesh's root directory:

    qmake -spec macx-g++       ## Generates the appropriate Makefiles
    -make release      ## Builds the project (use 'make debug' to build debug version)
    +make                       ## Builds the project (use 'make debug' to build debug version)
     - **/ -- GitLab