-Once installed, this directory contains a Makefile and
-a small program that you could use as a template when
-writing your own analysis software.
+Once installed, this directory contains CMakelist.txt,
+Makefile.pkg and a small program that you could use as
+a template when writing your own analysis software.
+Further explanation for the template code can be found
+in the Doxygen documentation (link to the latest development
+version):
+ <http://jenkins.gromacs.org/job/Documentation_Gerrit_Nightly/javadoc/doxygen/html-user/page_analysistemplate.xhtml>
-A Makefile.arch is created for each architecture you install
-(the first one is linked to Makefile) with the correct paths
-and libraries. If there is more than one, copy the one
-that corresponds best to your computer.
+The CMakelist.txt can be used together with cmake to
+build the template program:
+$ source /path/to/GMXRC
+$ cmake /path/to/template
+Alternatively, setting CMAKE_PREFIX_PATH will direct cmake
+to find a particular GROMACS installation.
-----------------------------------------------------------
+The Makefile.pkg can be used if cmake is unavailable. It
+makes use of pkg-config to build the template program:
+$ source /path/to/GMXRC
+$ make -f Makefile.pkg
-If you are reading this in the distribution directory,
-there will be a Makefile.am which automake uses to
-create a Makefile.in which in turn is converted to
-a Makefile by the configure script. Note that this is
-NOT the template makefile - it is called Template.mak,
-and used to create Makefile.arch at build time.
+You will need to make sure that you use a sufficiently similar C++
+compiler and C++ Standard Library as the one that was used for
+compiling GROMACS, preferably the same one. Boost headers used to
+compile GROMACS are also required, and are automatically added to
+the include path by both of the above build systems.
+See the Doxygen documentation for using GROMACS as a library for
+more details about the build system used to build the template, as
+well as its limitations (link to the latest development version):
+ <http://jenkins.gromacs.org/job/Documentation_Gerrit_Nightly/javadoc/doxygen/html-user/page_usinglibrary.xhtml>
-You should NOT touch or copy Makefile.in unless you
-really know what you are doing - it is a template file
-used by the configure script to create the real Makefile.
+----------------------------------------------------------
-If you want to use automake and autoconf yourself, look
-in the contrib directory of the distribution.
+If you are reading this in the distribution directory,
+remember that CMakelist.txt.template will be renamed to
+CMakelist.txt during the installation.
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff