summaryrefslogtreecommitdiffstats
path: root/config/cmake/README.txt.cmake.in
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2022-01-14 23:28:04 (GMT)
committerGitHub <noreply@github.com>2022-01-14 23:28:04 (GMT)
commit8b3c09f780e31ba96b9f5c370a0c19f8a0dcfe6c (patch)
treea72c114882cf0a2da885a0764402defd0d338d6e /config/cmake/README.txt.cmake.in
parente56b0a3d508b73746c9676b56b275d0e7a486b7b (diff)
downloadhdf5-8b3c09f780e31ba96b9f5c370a0c19f8a0dcfe6c.zip
hdf5-8b3c09f780e31ba96b9f5c370a0c19f8a0dcfe6c.tar.gz
hdf5-8b3c09f780e31ba96b9f5c370a0c19f8a0dcfe6c.tar.bz2
Updated README.txt to README.md (#1375)
* H5Lexists docs: Removed reference to 1.8.16 since the change is the 1.8.x releases, HDFFV-11289 * H5Oget_info_by_name, name can be any object, not just a group * Converted README.txt to README.md and updated files referring to README.txt to README.md. * removed references to README.txt * updated MANIFEST
Diffstat (limited to 'config/cmake/README.txt.cmake.in')
-rw-r--r--config/cmake/README.txt.cmake.in80
1 files changed, 0 insertions, 80 deletions
diff --git a/config/cmake/README.txt.cmake.in b/config/cmake/README.txt.cmake.in
deleted file mode 100644
index 9289870..0000000
--- a/config/cmake/README.txt.cmake.in
+++ /dev/null
@@ -1,80 +0,0 @@
-@HDF5_PACKAGE_NAME@ version @HDF5_PACKAGE_VERSION_STRING@
-------------------------------------------------------------------------------
-
-This directory contains the binary (release) distribution of
-@HDF5_PACKAGE_NAME@ @HDF5_PACKAGE_VERSION_MAJOR@ that was compiled on;
- @BINARY_PLATFORM@.
-
-It was built with the following options:
- -- @LIB_TYPE@ C/C++/Fortran libraries
- -- SZIP (encoder enabled) and ZLIB
- -- @LIB_TYPE@ HDF5 tools
- -- Java @Java_VERSION@
-
-The contents of this directory are:
-
- COPYING - Copyright notice
- README.txt - This file
- @HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_INSTALL_ENDING@ - HDF5 Install Package
-
-This binary was built with the ZLIB and SZIP/Libaec external libraries and are
-included for convenience. Libaec is an unrestricted open-source replacement for SZIP
-(version 1.0.4, Encoder ENABLED).
-
-The official ZLIB and SZIP/Libaec pages are at:
-
- ZLIB: https://git.savannah.gnu.org/cgit/gzip.git/
- https://git.savannah.gnu.org/cgit/gzip.git/tree/COPYING
- SZIP/Libaec: https://gitlab.dkrz.de/k202009/libaec
- https://gitlab.dkrz.de/k202009/libaec/-/blob/master/Copyright.txt
-
-
-Installation
-===========================================================================
-1. Execute @HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_INSTALL_ENDING@
-2. Follow prompts
-===========================================================================
-
-After Installation
-===========================================================================
-The examples folder, HDF5Examples, located in the
-HDF5 install folder, can be built and tested with CMake and the supplied
-HDF5_Examples.cmake file. The HDF5_Examples.cmake expects HDF5 to have
-been installed in the default location with above compilers (see the
-libhdf5.settings file in the lib install folder). Also, the CMake
-utility should be installed.
-
-To test the installation with the examples;
- Create a directory to run the examples.
- Copy HDF5Examples folder to this directory.
- Copy CTestScript.cmake to this directory.
- Copy HDF5_Examples.cmake to this directory.
- Copy HDF5_Examples_options.cmake to this directory.
- The default source folder is defined as "HDF5Examples". It can be changed
- with the CTEST_SOURCE_NAME script option.
- The default installation folder is defined as "@CMAKE_INSTALL_PREFIX@".
- It can be changed with the INSTALLDIR script option.
- The default ctest configuration is defined as "Release". It can be changed
- with the CTEST_CONFIGURATION_TYPE script option. Note that this must
- be the same as the value used with the -C command line option.
- The default build configuration is defined to build and use static libraries.
- Shared libraries can be used with the STATICONLYLIBRARIES script option set to "NO".
- Other options can be changed by editing the HDF5_Examples_options.cmake file.
-
- If the defaults are okay, execute from this directory:
- ctest -S HDF5_Examples.cmake -C Release -V -O test.log
- If the defaults need change, execute from this directory:
- ctest -S HDF5_Examples.cmake,CTEST_SOURCE_NAME=MyExamples,INSTALLDIR=MyLocation -C Release -V -O test.log
-
-When executed, the ctest script will save the results to the log file, test.log, as
-indicated by the ctest command. If you wish the to see more build and test information,
-add "-VV" to the ctest command. The output should show;
- 100% tests passed, 0 tests failed out of 156.
-
-For more information see USING_CMake_Examples.txt in the install folder.
-===========================================================================
-
-Documentation for this release can be found at the following URL:
- https://portal.hdfgroup.org/display/HDF5/HDF5
-
-Bugs should be reported to help@hdfgroup.org.