From 9dc859d7e880f1b4810ce7a50a3a9b67a08ec9b8 Mon Sep 17 00:00:00 2001 From: Giovanni Bussi <giovanni.bussi@gmail.com> Date: Mon, 17 Dec 2018 13:13:10 +0100 Subject: [PATCH] Draft module doc @@tetsuyamorishita please fill the module documentation with some text. Thanks! --- user-doc/LOGMFD.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 user-doc/LOGMFD.md diff --git a/user-doc/LOGMFD.md b/user-doc/LOGMFD.md new file mode 100644 index 000000000..a4ee15c01 --- /dev/null +++ b/user-doc/LOGMFD.md @@ -0,0 +1,26 @@ +\page LOGMFD xxxxxxxx + +<!-- +description: xxxxxxxxx +authors: xxxxxxxxx +reference: xxxxxxxxxx +--> + +## Overview + +xxxxxxxxx + +## Installation +This module is not installed by default. Add '\-\-enable-modules=logmfd' to your './configure' command when building PLUMED to enable these features. + +## Usage +Currently, all features of the LOGMFD module are included in a single LOGMFD bias function: \ref LOGMFD + +## Module Contents +- \subpage LOGMFDMODBias + +\page LOGMFDMODBias Biases Documentation + +The following list contains descriptions of biases developed for the PLUMED-LOGMFD module. They can be used in combination with other biases outside of the LOGMFD module. + +@LOGMFDMOD_BIAS@ -- GitLab