share/template/README

   1 Once installed, this directory contains CMakelist.txt,
   2 Makefile.pkg and a small program that you could use as
   3 a template when writing your own analysis software.
   4 Further explanation for the template code can be found
   5 in the Doxygen documentation (link to the latest development
   6 version):
   7   <http://jenkins.gromacs.org/job/Documentation_Gerrit_Nightly/javadoc/doxygen/html-user/page_analysistemplate.xhtml>
   8
   9 The CMakelist.txt can be used together with cmake to
  10 build the template program:
  11 $ source /path/to/GMXRC
  12 $ cmake /path/to/template
  13 Alternatively, setting CMAKE_PREFIX_PATH will direct cmake
  14 to find a particular GROMACS installation.
  15
  16 The Makefile.pkg can be used if cmake is unavailable. It
  17 makes use of pkg-config to build the template program:
  18 $ source /path/to/GMXRC
  19 $ make -f Makefile.pkg
  20
  21 You will need to make sure that you use a sufficiently similar C++
  22 compiler and C++ Standard Library as the one that was used for
  23 compiling GROMACS, preferably the same one.  Boost headers used to
  24 compile GROMACS are also required, and are automatically added to
  25 the include path by both of the above build systems.
  26 See the Doxygen documentation for using GROMACS as a library for
  27 more details about the build system used to build the template, as
  28 well as its limitations (link to the latest development version):
  29   <http://jenkins.gromacs.org/job/Documentation_Gerrit_Nightly/javadoc/doxygen/html-user/page_usinglibrary.xhtml>
  30
  31 ----------------------------------------------------------
  32
  33 If you are reading this in the distribution directory,
  34 remember that CMakelist.txt.template will be renamed to
  35 CMakelist.txt during the installation.