From 895ee04bb1d6dd3092071241bb3cc2a6590eca39 Mon Sep 17 00:00:00 2001 From: Mark Abraham Date: Mon, 24 Oct 2016 17:45:24 +0200 Subject: [PATCH] Add INSTALL-dev to aid people doing unusual builds Occasionally it is useful to build GROMACS other than from an official release tarball, e.g. when testing a new feature. The contents of this file will help such people to find the right documentation, without compromising clarity for normal installations from the tarball. Change-Id: I38d957fe0d1ca2ba1e509ed30bb93a100f018306 --- INSTALL-dev | 16 ++++++++++++++++ cmake/gmxCPackUtilities.cmake | 4 ++-- 2 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 INSTALL-dev diff --git a/INSTALL-dev b/INSTALL-dev new file mode 100644 index 0000000000..b6e0836179 --- /dev/null +++ b/INSTALL-dev @@ -0,0 +1,16 @@ +The GROMACS developers generally suggest you install GROMACS for +production scientific use only from a tarball from an official +source-code release. + +However, if you have a special need and wish to build and/or install a +version from a git repository, please see +docs/install-guide/index.rst in this repository, or (if applicable) +the latest master branch documentation found via +http://manual.gromacs.org/documentation/. + +Note for GROMACS developers +--------------------------- +This file is excluded from the GROMACS source packages made with CPack, +and not included into binary packages made with CPack. Source packages +do include an INSTALL file containing the installation instructions, which +has been compiled into plain text by Sphinx from docs/install-guide. diff --git a/cmake/gmxCPackUtilities.cmake b/cmake/gmxCPackUtilities.cmake index 5e80714cd9..7867998a8a 100644 --- a/cmake/gmxCPackUtilities.cmake +++ b/cmake/gmxCPackUtilities.cmake @@ -1,7 +1,7 @@ # # This file is part of the GROMACS molecular simulation package. # -# Copyright (c) 2014,2015, by the GROMACS development team, led by +# Copyright (c) 2014,2015,2016, by the GROMACS development team, led by # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl, # and including many others, as listed in the AUTHORS file in the # top-level source directory and at http://www.gromacs.org. @@ -119,7 +119,7 @@ function (gmx_cpack_write_config) set(CPACK_SOURCE_GENERATOR TGZ) set(CPACK_SOURCE_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}") set(CPACK_SOURCE_IGNORE_FILES - "\\\\.isreposource$;\\\\.git/;\\\\.gitignore$;\\\\.gitattributes;") + "\\\\.isreposource$;\\\\.git/;\\\\.gitignore$;\\\\.gitattributes;INSTALL-dev;") # Get the list of directories added with gmx_cpack_add_generated_source_directory() get_property(CPACK_SOURCE_INSTALLED_DIRECTORIES GLOBAL PROPERTY GMX_CPACK_SOURCE_INSTALLED_DIRECTORIES) -- 2.11.4.GIT