Introduction

Man pages

Man pages are available inside the doc/man directory:

  • To see the mmg2d man page, run man ./doc/man/mmg2d.1.gz

  • To see the mmgs man page, run man ./doc/man/mmgs.1.gz

  • To see the mmg3d man page, run man ./doc/man/mmg3d.1.gz

Doxygen documentation

The Doxygen documentation related to the last release is available on the github pages related to the MmgTools organization.

To locally build mmg documentation, Doxygen is mandatory. To generate the doxygen documentation, run cmake -DBUILD_DOC=yes .. in the build directory. Then, running make doc compiles the project documentation under the doc directory of the build directory. Opening build/doc/index.html gives access to the produced output.

You may wish to adapt build/Doxyfile to your liking.

Continuous integration tests

Basic use

mmg applications may be test by enabling and running the continuous integration tests. It is recommended to run the tests in debug mode:

cmake -D CMAKE_BUILD_TYPE=Debug -D BUILD_TESTING=ON ..
make
ctest

Advanced use

Tests may be enabled or disabled using the CMake variables. Check out the install section for a list of these options. The following example command configures CTest to enable library tests for mmg3d only:

cmake -D TEST_LIBMMG3D=ON ..