diff --git a/Doc/compiling.docu b/Doc/compiling.docu new file mode 100644 index 00000000..5e7d7b33 --- /dev/null +++ b/Doc/compiling.docu @@ -0,0 +1,163 @@ +//----------------------------------------------------------------------------- + +/** \page compiling Compiling OpenMesh + +\section compilers Tested compilers + +%OpenMesh has been successfully tested for the following operating +systems / compilers. This is only a list of tested compilers. +More might be supported but are not tested. Make sure that your compiler +supports at least C++11 + + + + + + + + + + +
Linux +gcc >= 4.8.x
+clang >= 3.3
+
Windows +Microsoft Visual Studio 2013
+Microsoft Visual Studio 2015
+Microsoft Visual Studio 2017
+
Tested MacOS X Compilers +XCode
+
+ +\section req_libs Required libraries (Only if you want to build the included Apps) + +Install the following external libraries / frameworks if you want to use the included Applications:

+ + +
Qt5https://www.qt.io/download

+ +\section build_systems Chosing build system + +%OpenMesh can be built using the cmake build system. +
+
+ +\section sec_compiling_unix Unix + +\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
+
+ +\warning If your compiler does not support c++11 natively, you might have to enable it by changing the cmake call to:
+ cmake .. -DCMAKE_CXX_FLAGS=-std=c++98 + +You can choose the build type by using cmake with the flag
+-DCMAKE_BUILD_TYPE=(Debug|Release) The default is: Release
+ +Other flags are:
+-DBUILD_APPS=OFF to disable build of applications and
+-DCMAKE_INSTALL_PREFIX=<path> to specify the install path.
+ +When calling make install cmake will install %OpenMesh into this +directory using the subdirectories lib/include/bin. + +CMake builds both shared and static under Linux. + +Everything will then be build in the Build subdirectory containing the libraries in lib and the binaries in bin. + + +There are some additional targets:
+doc: Builds the Documentation
+doc-install: Builds the Documentation and installs it
+
+\note When you link against the static libraries of OpenMesh and get the error "can not be used when making a +shared object; recompile with -fPIC" you need to add "-fPIC" to the CMAKE_CXX_FLAGS. (This is usually added automatically) + + + + + + + + +\section sec_compiling_windows Windows + +\subsection windows_using_cmake Compiling OpenMesh using CMake + +Building OpenMesh on Windows requires cmake to generate the project files for Visual Studio. + + + + + +
+
+ +\section sec_compiling_macosx MacOS X + +Download and install required libraries as stated above. +You can download %OpenMesh's sources from www.openmesh.org or check out the latest repository via SVN:
+svn co http://www.openmesh.org/svnrepo/OpenMesh/trunk %OpenMesh.

+ +\subsection mac_using_cmake Compiling OpenMesh using CMake + +We recommend you to use CMake >= 3.7 as build system. This can also easily be installed +via MacPorts as well as the Qt >= 5.6 library which is used for some example applications +in %OpenMesh.
+Once installed, change to %OpenMesh's root directory and create a directory +named e.g. "buildDebug" (assuming you want to build with debug symbols).
+Then type in the following command to initially set up the build environment: +

+ +cmake ..            ## Generates the appropriate Makefiles
+ +
+Note: If the build directory is not a subdirectory of %OpenMesh's root folder, replace ".." with %OpenMesh's +absolute (or relative) path. +In order to manually set specific build variables, just type: +

+ +ccmake .            ## Configure build environment
+ +
+This opens the CMake configure tool. Change the CMAKE_BUILD_TYPE variable to "Release" in order to prepare build +for release configuration. Now, when everything is set up, just type: +

+ +make                ## Build %OpenMesh
+ +
+And optionally: +

+ +make doc            ## Build %OpenMesh's documentation
+ +
+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.). + +CMake builds both shared and static under MacOS X. + +**/ + + +//----------------------------------------------------------------------------- diff --git a/Doc/misc.docu b/Doc/misc.docu index 864127ef..73db2d39 100644 --- a/Doc/misc.docu +++ b/Doc/misc.docu @@ -27,167 +27,4 @@ The following naming conventions are used for the %OpenMesh code: **/ - -//----------------------------------------------------------------------------- - - -/** \page compiling Compiling OpenMesh - -\section compilers Tested compilers - -%OpenMesh has been successfully tested for the following operating -systems / compilers. This is only a list of tested compilers. More might be supported but are not tested. - - - - - - - - - - -
Linux -gcc 4.6.x
-gcc 4.7.x
-gcc 4.8.x
-gcc 4.9.x
-clang 3.3
-clang 3.4
-
Windows -Microsoft Visual Studio 2008
-Microsoft Visual Studio 2010
-Microsoft Visual Studio 2012
-Microsoft Visual Studio 2013
-Microsoft Visual Studio 2015
-
Tested MacOS X Compilers -XCode 4.3
-XCode 4.4
-XCode 4.5
-XCode 5.1.1
-Apple LLVM version 5.1 (clang-503.0.40) (based on LLVM 3.4svn)
-
- -\section req_libs Required libraries (Only for included Apps) - -Install the following external libraries / frameworks if you want to use the included Applications:

- - -
Qt4/Qt5http://qt-project.org/downloads

- -\section build_systems Chosing build system - -%OpenMesh can be built using the cmake build system. -
-
- -\section sec_compiling_unix Unix - -\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
-
-You can choose the build type by using cmake with the flag
--DCMAKE_BUILD_TYPE=(Debug|Release)
-The default is: Debug -
-Other flags are:
--DBUILD_APPS=OFF to disable build of applications and
--DCMAKE_INSTALL_PREFIX=<path> to specify the install path. -
-When calling make install cmake will install %OpenMesh into this -directory using the subdirectories lib/include/bin. - -CMake builds both shared and static under Linux. - -Everything will then be build in the Build subdirectory containing the libraries in lib and the binaries in bin. - -There are some additional targets:
-doc: Builds the Documentation
-doc-install: Builds the Documentation and installs it
-
-\note When you link against the static libraries of OpenMesh and get the error "can not be used when making a -shared object; recompile with -fPIC" you need to add "-fPIC" to the CMAKE_CXX_FLAGS. (This is usually added automatically) - -\section sec_compiling_windows Windows - -\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).

- - -Note: Set the CMAKE_BUILD_TYPE variable to "Release" if you want %OpenMesh to be built as release. -In Visual Studio choose "Release" in the appropriate select box and build the solution afterwards. - -
-
- -\section sec_compiling_macosx MacOS X - -Download and install required libraries as stated above. -You can download %OpenMesh's sources from www.openmesh.org or check out the latest repository via SVN:
-svn co http://www.openmesh.org/svnrepo/OpenMesh/trunk %OpenMesh.

- -\subsection mac_using_cmake Compiling OpenMesh using CMake - -We recommend you to use CMake >= 2.8 as build system. This can also easily be installed -via MacPorts as well as the Qt >= 4.7 library which is used for some example applications -in %OpenMesh.
-Once installed, change to %OpenMesh's root directory and create a directory -named e.g. "buildDebug" (assuming you want to build with debug symbols).
-Then type in the following command to initially set up the build environment: -

- -cmake ..            ## Generates the appropriate Makefiles
- -
-Note: If the build directory is not a subdirectory of %OpenMesh's root folder, replace ".." with %OpenMesh's -absolute (or relative) path. -In order to manually set specific build variables, just type: -

- -ccmake .            ## Configure build environment
- -
-This opens the CMake configure tool. Change the CMAKE_BUILD_TYPE variable to "Release" in order to prepare build -for release configuration. Now, when everything is set up, just type: -

- -make                ## Build %OpenMesh
- -
-And optionally: -

- -make doc            ## Build %OpenMesh's documentation
- -
-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.). - -CMake builds both shared and static under MacOS X. - -**/ - - //-----------------------------------------------------------------------------