From 8b3c09f780e31ba96b9f5c370a0c19f8a0dcfe6c Mon Sep 17 00:00:00 2001
From: Scot Breitenfeld <brtnfld@hdfgroup.org>
Date: Fri, 14 Jan 2022 17:28:04 -0600
Subject: 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
---
 CMakeInstallation.cmake              |   2 +-
 MANIFEST                             |   5 ++-
 README.md                            |  85 +++++++++++++++++++++++++++++++++++
 README.txt                           |  80 ---------------------------------
 bin/bbrelease                        |   4 +-
 bin/h5vers                           |  12 ++---
 bin/release                          |   4 +-
 config/cmake/README.md.cmake.in      |  80 +++++++++++++++++++++++++++++++++
 config/cmake/README.txt.cmake.in     |  80 ---------------------------------
 config/cmake_ext_mod/HDFMacros.cmake |   6 +--
 configure.ac                         |   4 +-
 doxygen/img/HDF5.png                 | Bin 0 -> 10660 bytes
 12 files changed, 184 insertions(+), 178 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.txt
 create mode 100644 config/cmake/README.md.cmake.in
 delete mode 100644 config/cmake/README.txt.cmake.in
 create mode 100644 doxygen/img/HDF5.png

diff --git a/CMakeInstallation.cmake b/CMakeInstallation.cmake
index b506f05..609cd7e 100644
--- a/CMakeInstallation.cmake
+++ b/CMakeInstallation.cmake
@@ -182,7 +182,7 @@ if (HDF5_PACK_EXAMPLES)
 endif ()
 
 #-----------------------------------------------------------------------------
-# Configure the README.txt file for the binary package
+# Configure the README.md file for the binary package
 #-----------------------------------------------------------------------------
 HDF_README_PROPERTIES(HDF5_BUILD_FORTRAN)
 
diff --git a/MANIFEST b/MANIFEST
index c272a13..72e969a 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -28,7 +28,7 @@
 ./MANIFEST
 ./Makefile.dist
 ./Makefile.am
-./README.txt
+./README.md
 ./acsite.m4
 ./autogen.sh
 ./configure.ac
@@ -290,6 +290,7 @@
 ./doxygen/img/FF-IH_FileGroup.gif
 ./doxygen/img/FF-IH_FileObject.gif
 ./doxygen/img/FileFormatSpecChunkDiagram.jpg
+./doxygen/img/HDF5.png
 ./doxygen/img/HDFG-logo.png
 ./doxygen/img/IOFlow.gif
 ./doxygen/img/IOFlow2.gif
@@ -3629,7 +3630,7 @@
 ./config/cmake/mccacheinit.cmake
 ./config/cmake/patch.xml
 ./config/cmake/PkgInfo.in
-./config/cmake/README.txt.cmake.in
+./config/cmake/README.md.cmake.in
 ./config/cmake/UseJava.cmake
 ./config/cmake/UseJavaClassFilelist.cmake
 ./config/cmake/UseJavaSymlinks.cmake
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ce92342
--- /dev/null
+++ b/README.md
@@ -0,0 +1,85 @@
+HDF5 version 1.13.1-1 currently under development
+
+![HDF5 Logo](doxygen/img/HDF5.png)
+
+*Please refer to the release_docs/INSTALL file for installation instructions.*
+
+THE HDF GROUP
+---------------
+
+The HDF Group is the developer of HDF5®, a high-performance software library and
+data format that has been adopted across multiple industries and has become a
+de facto standard in scientific and research communities.
+
+More information about The HDF Group, the HDF5 Community and the HDF5 software
+project, tools and services can be found at the Group's website.
+    
+   https://www.hdfgroup.org/
+
+
+DOCUMENTATION
+-------------
+This release is fully functional for the API described in the documentation.
+    
+   https://portal.hdfgroup.org/display/HDF5/The+HDF5+API
+
+Full Documentation and Programming Resources for this release can be found at
+
+   https://portal.hdfgroup.org/display/HDF5
+
+See the RELEASE.txt file in the release_docs/ directory for information specific
+to the features and updates included in this release of the library.
+
+Several more files are located within the release_docs/ directory with specific
+details for several common platforms and configurations.
+
+    INSTALL - Start Here. General instructions for compiling and installing the library
+    INSTALL_CMAKE  - instructions for building with CMake (Kitware.com)
+    INSTALL_parallel - instructions for building and configuring Parallel HDF5
+    INSTALL_Windows and INSTALL_Cygwin - MS Windows installations.
+
+
+
+HELP AND SUPPORT
+----------------
+Information regarding Help Desk and Support services is available at
+
+   https://portal.hdfgroup.org/display/support/The+HDF+Help+Desk
+
+
+
+FORUM and NEWS
+--------------
+The following public forums are provided for public announcements and discussions
+of interest to the general HDF5 Community.
+
+   - Homepage of the Forum
+   https://forum.hdfgroup.org
+
+   - News and Announcement
+   https://forum.hdfgroup.org/c/news-and-announcements-from-the-hdf-group
+
+   - HDF5 and HDF4 Topics
+   https://forum.hdfgroup.org/c/hdf5
+
+These forums are provided as an open and public service for searching and reading.
+Posting requires completing a simple registration and allows one to join in the
+conversation.  Please read the following instructions pertaining to the Forum's
+use and configuration
+    https://forum.hdfgroup.org/t/quickstart-guide-welcome-to-the-new-hdf-forum
+
+
+SNAPSHOTS, PREVIOUS RELEASES AND SOURCE CODE
+--------------------------------------------
+Periodically development code snapshots are provided at the following URL:
+    
+   https://gamma.hdfgroup.org/ftp/pub/outgoing/hdf5/snapshots/
+
+Source packages for current and previous releases are located at:
+    
+   https://portal.hdfgroup.org/display/support/Downloads
+
+Development code is available at our Github location:
+    
+   https://github.com/HDFGroup/hdf5.git
+
diff --git a/README.txt b/README.txt
deleted file mode 100644
index b9cfe8a..0000000
--- a/README.txt
+++ /dev/null
@@ -1,80 +0,0 @@
-HDF5 version 1.13.1-1 currently under development
-
-------------------------------------------------------------------------------
-Please refer to the release_docs/INSTALL file for installation instructions.
-------------------------------------------------------------------------------
-
-THE HDF GROUP
----------------
-
-The HDF Group is the developer of HDF5®, a high-performance software library and
-data format that has been adopted across multiple industries and has become a
-de facto standard in scientific and research communities.
-
-More information about The HDF Group, the HDF5 Community and the HDF5 software
-project, tools and services can be found at the Group's website.
-
-    https://www.hdfgroup.org/
-
-
-DOCUMENTATION
--------------
-This release is fully functional for the API described in the documentation.
-    https://portal.hdfgroup.org/display/HDF5/The+HDF5+API
-
-Full Documentation and Programming Resources for this release can be found at
-    https://portal.hdfgroup.org/display/HDF5
-
-See the RELEASE.txt file in the release_docs/ directory for information specific
-to the features and updates included in this release of the library.
-
-Several more files are located within the release_docs/ directory with specific
-details for several common platforms and configurations.
-
-    INSTALL - Start Here. General instructions for compiling and installing the library
-    INSTALL_CMAKE  - instructions for building with CMake (Kitware.com)
-    INSTALL_parallel - instructions for building and configuring Parallel HDF5
-    INSTALL_Windows and INSTALL_Cygwin - MS Windows installations.
-
-
-
-HELP AND SUPPORT
-----------------
-Information regarding Help Desk and Support services is available at
-
-    https://portal.hdfgroup.org/display/support/The+HDF+Help+Desk
-
-
-
-FORUM and NEWS
---------------
-The following public forums are provided for public announcements and discussions
-of interest to the general HDF5 Community.
-
-    Homepage of the Forum
-        https://forum.hdfgroup.org
-
-    News and Announcement
-        https://forum.hdfgroup.org/c/news-and-announcements-from-the-hdf-group
-
-    HDF5 and HDF4 Topics
-        https://forum.hdfgroup.org/c/hdf5
-
-These forums are provided as an open and public service for searching and reading.
-Posting requires completing a simple registration and allows one to join in the
-conversation.  Please read the following instructions pertaining to the Forum's
-use and configuration
-    https://forum.hdfgroup.org/t/quickstart-guide-welcome-to-the-new-hdf-forum
-
-
-SNAPSHOTS, PREVIOUS RELEASES AND SOURCE CODE
---------------------------------------------
-Periodically development code snapshots are provided at the following URL:
-    https://gamma.hdfgroup.org/ftp/pub/outgoing/hdf5/snapshots/
-
-Source packages for current and previous releases are located at:
-    https://portal.hdfgroup.org/display/support/Downloads
-
-Development code is available at our Github location:
-    https://github.com/HDFGroup/hdf5.git
-
diff --git a/bin/bbrelease b/bin/bbrelease
index cdb8678..a45be2e 100755
--- a/bin/bbrelease
+++ b/bin/bbrelease
@@ -320,9 +320,9 @@ ln -s `pwd` $tmpdir/$HDF5_IN_VERS || exit 1
 test -f Makefile && mv Makefile $tmpdir/Makefile.x
 cp -p Makefile.dist Makefile
 
-# Update README.txt and release_docs/RELEASE.txt with release information in
+# Update README.md and release_docs/RELEASE.txt with release information in
 # line 1.
-for f in README.txt release_docs/RELEASE.txt; do
+for f in README.md release_docs/RELEASE.txt; do
     echo "HDF5 version $VERS released on $release_date" >$f.x
     sed -e 1d $f >>$f.x
     mv $f.x $f
diff --git a/bin/h5vers b/bin/h5vers
index 8f75df1..04d5d03 100755
--- a/bin/h5vers
+++ b/bin/h5vers
@@ -66,7 +66,7 @@ use strict;
 # ./H5public.h or ./src/H5public.h.
 #
 # If the version number is changed (either `-s' or `-i' was used on
-# the command line) then the first line of the README.txt and RELEASE.txt files
+# the command line) then the version line of the README.md and RELEASE.txt files
 # one directory above the H5public.h file is also modified so it looks
 # something like: This is hdf5-1.2.3-pre1 currently under development.
 # The AC_INIT macro in configure.ac will also change in this case to be
@@ -156,10 +156,10 @@ while ($_ = shift) {
 }
 die "mutually exclusive options given\n" if $set && $inc;
 
-# Determine file to use as H5public.h, README.txt,
+# Determine file to use as H5public.h, README.md,
 # release_docs/RELEASE.txt, configure.ac, windows/src/H5pubconf.h
 # config/lt_vers.am and config/cmake/scripts/HDF5config.cmake. 
-# The README.txt, release_docs/RELEASE.txt, configure.ac, 
+# The README.md, release_docs/RELEASE.txt, configure.ac, 
 # windows/src/H5pubconf.h, config/lt_vers.am and
 # config/cmake/scripts/HDF5config.cmake
 # files are always in the directory above H5public.h
@@ -178,9 +178,9 @@ die "unable to read file: $LT_VERS\n" unless -r $file;
 my $HDF5CONFIGCMAKE = $file;
 $HDF5CONFIGCMAKE =~ s/[^\/]*$/..\/config\/cmake\/scripts\/HDF5config.cmake/;
 die "unable to read file: $HDF5CONFIGCMAKE\n" unless -r $file;
-# README.txt
+# README.md
 my $README = $file;
-$README =~ s/[^\/]*$/..\/README.txt/;
+$README =~ s/[^\/]*$/..\/README.md/;
 die "unable to read file: $README\n" unless -r $file;
 # release_docs/RELEASE.txt
 my $RELEASE = $file;
@@ -303,7 +303,7 @@ if ($LT_VERS && $version_increased) {
 #  close FILE;
 }
 
-# Update the README.txt file
+# Update the README.md file
 if ($README) {
   open FILE, $README or die "$README: $!\n";
   my @contents = <FILE>;
diff --git a/bin/release b/bin/release
index e40c3d3..e71a38e 100755
--- a/bin/release
+++ b/bin/release
@@ -572,9 +572,9 @@ ln -s `pwd` $tmpdir/$HDF5_VERS || exit 1
 test -f Makefile && mv Makefile $tmpdir/Makefile.x
 cp -p Makefile.dist Makefile
 
-# Update README.txt and release_docs/RELEASE.txt with release information in
+# Update README.md and release_docs/RELEASE.txt with release information in
 # line 1.
-for f in README.txt release_docs/RELEASE.txt; do
+for f in README.md release_docs/RELEASE.txt; do
     echo "HDF5 version $VERS released on $release_date" >$f.x
     sed -e 1d $f >>$f.x
     mv $f.x $f
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.
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.
diff --git a/config/cmake_ext_mod/HDFMacros.cmake b/config/cmake_ext_mod/HDFMacros.cmake
index 6da2b74..a774130 100644
--- a/config/cmake_ext_mod/HDFMacros.cmake
+++ b/config/cmake_ext_mod/HDFMacros.cmake
@@ -223,7 +223,7 @@ macro (TARGET_C_PROPERTIES wintarget libtype)
 endmacro ()
 
 #-----------------------------------------------------------------------------
-# Configure the README.txt file for the binary package
+# Configure the README.md file for the binary package
 #-----------------------------------------------------------------------------
 macro (HDF_README_PROPERTIES target_fortran)
   set (BINARY_SYSTEM_NAME ${CMAKE_SYSTEM_NAME})
@@ -301,8 +301,8 @@ macro (HDF_README_PROPERTIES target_fortran)
   endif ()
 
   configure_file (
-      ${HDF_RESOURCES_DIR}/README.txt.cmake.in
-      ${CMAKE_BINARY_DIR}/README.txt @ONLY
+      ${HDF_RESOURCES_DIR}/README.md.cmake.in
+      ${CMAKE_BINARY_DIR}/README.md @ONLY
   )
 endmacro ()
 
diff --git a/configure.ac b/configure.ac
index 2520249..8d7f359 100644
--- a/configure.ac
+++ b/configure.ac
@@ -3675,8 +3675,8 @@ fi
 ## and installed with the libraries (used to generate libhdf5.settings).
 ##
 
-## HDF5 version from the first line of the README.txt file.
-H5_VERSION="`cut -d' ' -f3 $srcdir/README.txt | head -1`"
+## HDF5 version from the first line of the README.md file.
+H5_VERSION="`cut -d' ' -f3 $srcdir/README.md | head -1`"
 AC_SUBST([H5_VERSION])
 
 ## Configuration date
diff --git a/doxygen/img/HDF5.png b/doxygen/img/HDF5.png
new file mode 100644
index 0000000..0458fa8
Binary files /dev/null and b/doxygen/img/HDF5.png differ
-- 
cgit v0.12