From 7705171721e825d58e1e867e552e328fc812bfdd Mon Sep 17 00:00:00 2001
From: Matthew Masarik <86749872+MatthewMasarik-NOAA@users.noreply.github.com>
Date: Fri, 8 Nov 2024 10:47:05 -0800
Subject: [PATCH] README.md: update with link to doxygen documentation (#1316)
---
README.md | 25 +++++++++++++------------
1 file changed, 13 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index fa2c1df63..42ac91178 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,25 @@
# The WAVEWATCH III Framework
-WAVEWATCH III® is a community wave modeling framework that includes the
+WAVEWATCH III® is a community wave modeling framework that includes the
latest scientific advancements in the field of wind-wave modeling and dynamics.
## General Features
-WAVEWATCH III® solves the random phase spectral action density
-balance equation for wavenumber-direction spectra. The model includes options
-for shallow-water (surf zone) applications, as well as wetting and drying of
-grid points. Propagation of a wave spectrum can be solved using regular
-(rectilinear or curvilinear) and unstructured (triangular) grids. See
-[About WW3](https://github.com/NOAA-EMC/WW3/wiki/About-WW3) for a
-detailed description of WAVEWATCH III® .
+WAVEWATCH III® solves the random phase spectral action density
+balance equation for wavenumber-direction spectra. The model includes options
+for shallow-water (surf zone) applications, as well as wetting and drying of
+grid points. Propagation of a wave spectrum can be solved using regular
+(rectilinear or curvilinear) and unstructured (triangular) grids. See
+[About WW3](https://github.com/NOAA-EMC/WW3/wiki/About-WW3) for a
+detailed description of WAVEWATCH III®. For a web-based
+view of the WAVEWATCH III® source code
+refer to the [WW3 doxygen documentation](https://noaa-emc.github.io/WW3).
## Installation
-The WAVEWATCH III® framework package has two parts that need to be combined so
-all runs smoothly: the GitHub repo itself, and a binary data file bundle that
-needs to be obtained from our ftp site. Steps to successfully acquire and install
+The WAVEWATCH III® framework package has two parts that need to be combined so
+all runs smoothly: the GitHub repo itself, and a binary data file bundle that
+needs to be obtained from our ftp site. Steps to successfully acquire and install
the framework are outlined in our [Quick Start](https://github.com/NOAA-EMC/WW3/wiki/Quick-Start)
guide.
@@ -35,4 +37,3 @@ endorsement, recommendation or favoring by the Department of Commerce. The
Department of Commerce seal and logo, or the seal and logo of a DOC bureau,
shall not be used in any manner to imply endorsement of any commercial product
or activity by DOC or the United States Government.
-