summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDana Robinson <43805+derobins@users.noreply.github.com>2023-01-05 00:28:26 (GMT)
committerGitHub <noreply@github.com>2023-01-05 00:28:26 (GMT)
commit6101a0cc836a42d99ac4fb9097ad396c007d3a05 (patch)
tree6ce839e27006de4327ceb1813b3ecc1c46a76af2
parent91aa02817a957831ddd363af7e4e9232b7202f25 (diff)
downloadhdf5-6101a0cc836a42d99ac4fb9097ad396c007d3a05.zip
hdf5-6101a0cc836a42d99ac4fb9097ad396c007d3a05.tar.gz
hdf5-6101a0cc836a42d99ac4fb9097ad396c007d3a05.tar.bz2
Brings README.md changes from develop (#2389)
-rw-r--r--README.md38
-rw-r--r--doc/img/release-schedule.plantuml47
-rwxr-xr-xdoc/img/release-schedule.pngbin16991 -> 13977 bytes
3 files changed, 43 insertions, 42 deletions
diff --git a/README.md b/README.md
index 961c137..38e48ed 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,24 @@
-HDF5 version 1.12.3-1 currently under development
+HDF5 version 1.15.0 currently under development
![HDF5 Logo](doxygen/img/HDF5.png)
-*Please refer to the release_docs/INSTALL file for installation instructions.*
+[![develop build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/main.yml?branch=develop&label=develop)](https://github.com/HDFGroup/hdf5/actions?query=branch%3Adevelop)
+[![1.14 build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/main.yml?branch=hdf5_1_14&label=1.14)](https://github.com/HDFGroup/hdf5/actions?query=branch%3Ahdf5_1_14)
+[![1.12 build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/main.yml?branch=hdf5_1_12&label=1.12)](https://github.com/HDFGroup/hdf5/actions?query=branch%3Ahdf5_1_12)
+[![1.10 build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/main.yml?branch=hdf5_1_10&label=1.10)](https://github.com/HDFGroup/hdf5/actions?query=branch%3Ahdf5_1_10)
+[![1.8 build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/main.yml?branch=hdf5_1_8&label=1.8)](https://github.com/HDFGroup/hdf5/actions?query=branch%3Ahdf5_1_8)
+[![BSD](https://img.shields.io/badge/License-BSD-blue.svg)](https://github.com/HDFGroup/hdf5/blob/develop/COPYING)
-THE HDF GROUP
----------------
+*Please refer to the release_docs/INSTALL file for installation instructions.*
-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.
+This repository contains a high-performance library's source code and a file format
+specification that implement the HDF5® data model. The model has been adopted across
+many industries and this implementation has become a de facto data management standard
+in science, engineering, and research communities worldwide.
-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.
+The HDF Group is the developer, maintainer, and steward of HDF5 software. Find more
+information about The HDF Group, the HDF5 Community, and other HDF5 software projects,
+tools, and services at The HDF Group's website.
https://www.hdfgroup.org/
@@ -77,13 +83,19 @@ RELEASE SCHEDULE
HDF5 does not release on a regular schedule. Instead, releases are driven by
new features and bug fixes, though we try to have at least one release of each
maintenance branch per year. Future HDF5 releases indicated on this schedule
-are tentative.
+are tentative.
+
+**NOTE**: HDF5 1.12 is being retired early due to its incomplete and incompatible VOL
+layer.
| Release | New Features |
| ------- | ------------ |
-| 1.13.2 | VFD SWMR, Onion VFD, Selection I/O |
-| 1.13.3 | Multi-Dataset I/O |
-| 1.13.4 | Subfiling |
+| 1.8.23 | last HDF5 1.8 release |
+| 1.10.10 | CVE fixes, performance improvements, H5Dchunk\_iter() |
+| 1.12.3 | CVE fixes, performance improvements, H5Dchunk\_iter(), last HDF5 1.12 release |
+| 1.14.1 | selection I/O with datatype conversion |
+| 2.0.0 | TBD |
+| TBD | VFD SWMR |
This list of feature release versions is also tentative, and the specific release
in which a feature is introduced may change.
diff --git a/doc/img/release-schedule.plantuml b/doc/img/release-schedule.plantuml
index f5aa62a..c724dc9 100644
--- a/doc/img/release-schedule.plantuml
+++ b/doc/img/release-schedule.plantuml
@@ -2,44 +2,33 @@ The release timeline was generated on PlantUML (https://plantuml.com)
The current script:
-@startuml
+@startgantt
+
title HDF5 Release Schedule
projectscale monthly
-Project starts 2021-01-01
+Project starts 2022-01-01
-[1.8] starts 2021-01-01 and lasts 114 weeks
-[1.8.22] happens 2021-02-05
-[1.8.23] happens 2022-12-31
-[1.8.23] displays on same row as [1.8.22]
-[1.8] is colored in #CC6677
+[1.8] starts 2022-01-01 and lasts 57 weeks
+[1.8.23] happens 2023-01-31
+[1.8] is colored in #F76969
-[1.10] starts 2021-01-01 and lasts 114 weeks
-[1.10.8] happens 2021-10-22
+[1.10] starts 2022-01-01 and lasts 104 weeks
[1.10.9] happens 2022-05-31
-[1.10.9] displays on same row as [1.10.8]
-[1.10] is colored in #DDCC77
+[1.10.10] happens 2023-02-28
+[1.10.10] displays on same row as [1.10.9]
+[1.10] is colored in #F6DD60
-[1.12] starts 2021-01-01 and lasts 114 weeks
-[1.12.1] happens 2021-07-01
+[1.12] starts 2022-01-01 and lasts 65 weeks
[1.12.2] happens 2022-04-30
-[1.12.2] displays on same row as [1.12.1]
+[1.12.3] happens 2023-03-31
+[1.12.3] displays on same row as [1.12.2]
[1.12] is colored in #88CCEE
-[1.13] starts 2021-01-01 and lasts 104 weeks
-[1.13.0] happens 2021-12-01
-[1.13.1] happens 2022-03-02
-[1.13.2] happens 2022-06-31
-[1.13.3] happens 2022-08-31
-[1.13.4] happens 2022-10-31
-[1.13.1] displays on same row as [1.13.0]
-[1.13.2] displays on same row as [1.13.0]
-[1.13.3] displays on same row as [1.13.0]
-[1.13.4] displays on same row as [1.13.0]
-[1.13] is colored in #44AA99
-
-[1.14] starts at 2022-12-31 and lasts 10 weeks
+[1.14] starts at 2023-01-01 and lasts 52 weeks
[1.14.0] happens at 2022-12-31
-[1.14] is colored in #AA4499
-@enduml
+[1.14.1] happens at 2023-04-30
+[1.14.1] displays on same row as [1.14.0]
+[1.14] is colored in #B187CF
+@endgantt
diff --git a/doc/img/release-schedule.png b/doc/img/release-schedule.png
index c2ed241..b96f741 100755
--- a/doc/img/release-schedule.png
+++ b/doc/img/release-schedule.png
Binary files differ