Commit e4ec9752 authored by Mike Kremer's avatar Mike Kremer
Browse files

Wrote documentation on building OpenVolumeMesh

git-svn-id: http://www.openvolumemesh.org/svnrepo/OpenVolumeMesh/trunk@29 66977474-1d4b-4f09-8fe9-267525286df2
parent f73e2e00
......@@ -2,4 +2,52 @@
\page building_openvolumemesh Building OpenVolumeMesh
\section building_prerequisites Prerequisites
%OpenVolumeMesh is equipped with a complete CMake (http://www.cmake.org) build system that should
make compiling the library on any platform pretty simple. Make sure you have at least CMake version 2.6
installed on your machine. Get the latest CMake sources or binaries at http://www.cmake.org.
If you are interested in contributing to %OpenVolumeMesh by developing on its
code base, we highly recommend to install the Google testing framework which can be found here: http://code.google.com/p/googletest/ .
This framework is needed in order to build and execute our included unit tests.
\section config_and_build Configuring and building OpenVolumeMesh on Linux and MacOSX
Open a terminal and extract the %OpenVolumeMesh sources or check out the latest subversion revision:
\verbatim
svn co http://www.openvolumemesh.org/svnrepo/OpenVolumeMesh/trunk OpenVolumeMesh --username=anonymous --password=anonymous
\endverbatim
It is recommended to build %OpenVolumeMesh out-of-source, so create a folder named e.g. "build" \e outside
the %OpenVolumeMesh sources root folder. Change to the newly created build directory and just type
\code
cmake /path/to/OpenVolumeMesh/sources
\endcode
Note that CMake configures the build such that it builds with debug symbols per default.
If you want to build with release settings (with optimizations turned on), use the tool
\code
ccmake .
\endcode
inside your build folder. Once everything is configured as desired, just type
\code
make
\endcode
inside the build folder. The built libraries can be found in the sub-folder
\c Build/lib. %OpenVolumeMesh will be built as a static as well as a dynamic library.
If you want to build %OpenVolumeMesh's documentation, simply type
\code
make doc
\endcode
inside the build folder. The generated doxygen documentation files can then be found in
\c Build/share/Doc/html.
**/
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment