diff options
| -rw-r--r-- | CMakeInstallation.cmake | 2 | ||||
| -rw-r--r-- | README.md (renamed from README.txt) | 42 | ||||
| -rwxr-xr-x | bin/h5vers | 12 | ||||
| -rw-r--r-- | config/cmake/README.md.cmake.in (renamed from config/cmake/README.txt.cmake.in) | 2 | ||||
| -rw-r--r-- | config/cmake_ext_mod/HDFMacros.cmake | 6 | ||||
| -rw-r--r-- | configure.ac | 4 |
6 files changed, 38 insertions, 30 deletions
diff --git a/CMakeInstallation.cmake b/CMakeInstallation.cmake index 2e95fc5..4411c8b 100644 --- a/CMakeInstallation.cmake +++ b/CMakeInstallation.cmake @@ -178,7 +178,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) @@ -1,8 +1,11 @@ HDF5 version 1.10.9-1 currently under development ------------------------------------------------------------------------------- -Please refer to the release_docs/INSTALL file for installation instructions. ------------------------------------------------------------------------------- + + +[](https://github.com/HDFGroup/hdf5/actions?query=branch%3Adevelop) +[](https://github.com/HDFGroup/hdf5/blob/develop/COPYING) + +*Please refer to the release_docs/INSTALL file for installation instructions.* THE HDF GROUP --------------- @@ -13,17 +16,19 @@ 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/ + + 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 + + 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 + + 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. @@ -42,7 +47,7 @@ HELP AND SUPPORT ---------------- Information regarding Help Desk and Support services is available at - https://portal.hdfgroup.org/display/support/The+HDF+Help+Desk + https://portal.hdfgroup.org/display/support/The+HDF+Help+Desk @@ -51,14 +56,14 @@ 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 + - Homepage of the Forum + https://forum.hdfgroup.org - News and Announcement - https://forum.hdfgroup.org/c/news-and-announcements-from-the-hdf-group + - 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 + - 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 @@ -90,11 +95,14 @@ in which a feature is introduced may change. 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/ + + 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 + + https://portal.hdfgroup.org/display/support/Downloads Development code is available at our Github location: - https://github.com/HDFGroup/hdf5.git + + https://github.com/HDFGroup/hdf5.git @@ -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 first 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/config/cmake/README.txt.cmake.in b/config/cmake/README.md.cmake.in index 9289870..b60e729 100644 --- a/config/cmake/README.txt.cmake.in +++ b/config/cmake/README.md.cmake.in @@ -14,7 +14,7 @@ It was built with the following options: The contents of this directory are: COPYING - Copyright notice - README.txt - This file + 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 diff --git a/config/cmake_ext_mod/HDFMacros.cmake b/config/cmake_ext_mod/HDFMacros.cmake index 53e9f8f..0f9b367 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 6a1016b..90dbeeb 100644 --- a/configure.ac +++ b/configure.ac @@ -3590,8 +3590,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 |