From fa184633d292b98694f1581bb08625e76a663ad2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20M=C3=B6bius?= Date: Tue, 28 Feb 2023 10:29:29 +0100 Subject: [PATCH] Added some documentation on how to build and run the unittests. --- Doc/compiling.docu | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/Doc/compiling.docu b/Doc/compiling.docu index 9c3dc186..57af03d4 100644 --- a/Doc/compiling.docu +++ b/Doc/compiling.docu @@ -176,4 +176,20 @@ CMake builds both shared and static under MacOS X. **/ +/** \page compiling_tests Compiling OpenMesh Unit Tests + +%OpenMesh comes with a set of unittests for all platforms. In order to run these +tests, you need to enable the cmake flag OPENMESH_BUILD_UNIT_TESTS. +You also need GoogleTest on your +machine. Configure the cmake variables in OpenMesh to point to your GTest include +dirs and libraries (check the Advanced button in cmake, if you don't see these +options). Than run cmake and build OpenMesh. + +Afterwards you should have a Unittests subdirectory in your binary build folder. +This directory includes the unittest executables and several test files for input +and output checks. You can run the executables directly, but +make sure, that the working directory is the directory where the executables are. + + **/ + //-----------------------------------------------------------------------------