Misc fixes from develop nov21 - feb22 (#1580)

* Make default to build high-level tools the same as default for (#1234)

high-level library.

* 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

* Snprintf2 (#1399)

* Replaced many uses of sprintf with safer snprintf

Many very straightforward, but in a few cases added a length parameter to some private functions, because buffer length was otherwise unknowable.

* Removed unnecessary use of static on small buffers

This improves thread safety.

* Committing clang-format changes

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* Replaced several uses of sprintf with safer snprintf (#1383)

* Replaced several uses of sprintf with safer snprintf

* Committing clang-format changes

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* Used clang-tidy to change all floating point f suffixes to F (#1359)

* Added another missing override keyword on a dtor (#1384)

* Creating FUNDING.yml (#1427)

* Creating FUNDING.yml

Will add sponsor this project widget to the repo's page.

* Correct file name

Add sponsor widget; filename typo fixed.

* Update MANIFEST

* Fixed AbstractDs::getVarLenType documentation (#1441)

* Committing clang-format changes

* Open bsd fixes (#1195)

* Fix end of line alignment.

Co-authored-by: Scot Breitenfeld <brtnfld@hdfgroup.org>
Co-authored-by: Sean McBride <sean@rogue-research.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: loricooperhdf <lori.cooper@hdfgroup.org>
Co-authored-by: myd7349 <myd7349@gmail.com>

1 files changed, 80 insertions, 0 deletions

diff --git a/config/cmake/README.md.cmake.in b/config/cmake/README.md.cmake.in
new file mode 100644
index 0000000..b60e729
--- /dev/null
+++ b/config/cmake/README.md.cmake.in
@@ -0,0 +1,80 @@
+@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.md               - 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.