Commit 37bd6fd8 authored by Jan Möbius's avatar Jan Möbius

Merge branch 'improve-docs' into 'master'

Improve docs

See merge request !46
parents 6caf6837 10149a57
Pipeline #8650 passed with stage
in 6 minutes and 40 seconds
......@@ -9,7 +9,7 @@ make compiling the library on any platform pretty simple. Make sure you have at
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.
code base, we highly recommend to install the Google testing framework which can be found here: https://github.com/google/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
......@@ -17,44 +17,44 @@ This framework is needed in order to build and execute our included unit tests.
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
git clone https://www.graphics.rwth-aachen.de:9000/OpenVolumeMesh/OpenVolumeMesh.git
\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
\verbatim
cmake /path/to/OpenVolumeMesh/sources
\endcode
\endverbatim
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
\verbatim
ccmake .
\endcode
\endverbatim
inside your build folder. Once everything is configured as desired, just type
\code
\verbatim
make
\endcode
\endverbatim
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
\verbatim
make doc
\endcode
\endverbatim
inside the build folder. The generated doxygen documentation files can then be found in
\c Build/share/Doc/html.
If you want to install the library as well as its header files, type:
\code
\verbatim
sudo make install
\endcode
\endverbatim
This installs the requested files into the \c lib and \c include folders in \c /usr/local (this is the default
value that can easily be changed using \c ccmake).
......@@ -64,9 +64,9 @@ This example has its own target defined in the CMake configuration file found in
This target is excluded from target \c all and has to be built explicitly.
You can easily build it by typing:
\code
\verbatim
make simple_mesh
\endcode
\endverbatim
The binary can then be found in \c Build/Examples, or whatever you have specified in the CMake configuration.
......
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