summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2023-07-20 14:39:47 (GMT)
committerGitHub <noreply@github.com>2023-07-20 14:39:47 (GMT)
commit9d7760b25cc2ebae68074fb4dd501182b0d201e9 (patch)
treee4faabc930df939723e3e99d5097fee6ed7004a8 /README.md
parentcac778a4c33e9f34eb4825fd82b892e01ca56406 (diff)
downloadhdf5-9d7760b25cc2ebae68074fb4dd501182b0d201e9.zip
hdf5-9d7760b25cc2ebae68074fb4dd501182b0d201e9.tar.gz
hdf5-9d7760b25cc2ebae68074fb4dd501182b0d201e9.tar.bz2
Fix documentation (#3253)
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 13 insertions, 16 deletions
diff --git a/README.md b/README.md
index 530ffaf..35302ba 100644
--- a/README.md
+++ b/README.md
@@ -14,25 +14,26 @@ in science, engineering, and research communities worldwide.
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/
-
+tools, and services at [The HDF 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
+The latest doxygen documentation generated on changes to develop is available at:
+
+ https://hdfgroup.github.io/hdf5/
+
+See the [RELEASE.txt](/release_docs/RELEASE.txt) file in the [release_docs/](/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
+Several more files are located within the [release_docs/](/release_docs/) directory with specific
details for several common platforms and configurations.
INSTALL - Start Here. General instructions for compiling and installing the library
@@ -52,23 +53,19 @@ Information regarding Help Desk and Support services is available at
FORUM and NEWS
--------------
-The following public forums are provided for public announcements and discussions
+The [HDF Forum](https://forum.hdfgroup.org) is provided for public announcements and discussions
of interest to the general HDF5 Community.
- - Homepage of the Forum
- https://forum.hdfgroup.org
-
- - News and Announcement
+ - News and Announcements
https://forum.hdfgroup.org/c/news-and-announcements-from-the-hdf-group
- - HDF5 and HDF4 Topics
+ - HDF5 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
+conversation. Please read the [instructions](https://forum.hdfgroup.org/t/quickstart-guide-welcome-to-the-new-hdf-forum
+) pertaining to the Forum's use and configuration.