From ed6170148b06cd748510f1856d83fac1b4b8784b Mon Sep 17 00:00:00 2001 From: Soren Rasmussen Date: Mon, 25 Nov 2024 12:41:59 -0700 Subject: [PATCH] Adding readthedocs documentation links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8457e73fd..436f4e256 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # WRF-Hydro® [![Build Status](https://github.com/NCAR/wrf_hydro_nwm_public/actions/workflows/test-pr.yml/badge.svg?branch=main)](https://github.com/NCAR/wrf_hydro_nwm_public/actions/workflows/test-pr.yml) +[![Doc Build Status](https://readthedocs.org/projects/wrf-hydro/badge/?version=latest&style=flat)](https://wrf-hydro.readthedocs.io) [![Release](https://img.shields.io/github/release/NCAR/wrf_hydro_nwm_public.svg)](https://github.com/NCAR/wrf_hydro_nwm_public/releases/latest) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3625237.svg)](https://doi.org/10.5281/zenodo.3625237) @@ -10,8 +11,7 @@ This is the code repository for [WRF-Hydro®](https://ral.ucar.edu/projects/wrf_ WRF-Hydro is a community modeling system and framework for hydrologic modeling and model coupling. In 2016 a configuration of WRF-Hydro was implemented as the [National Water Model](http://water.noaa.gov/about/nwm) (NWM) for the continental United States. ## Documentation -Documentation and in-depth build instructions can be found on our [project website](https://ral.ucar.edu/projects/wrf_hydro/technical-description-user-guide). -Quick [build instructions](docs/BUILD.rst) for CMake are also available. +Documentation is available at [wrf-hydro.readthedocs.io](https://wrf-hydro.readthedocs.io) with further guides available at our [project website](https://ral.ucar.edu/projects/wrf_hydro/technical-description-user-guide). For getting started see the [dependencies](https://wrf-hydro.readthedocs.io/en/latest/model-code-config.html#requirements) and [build instructions](https://wrf-hydro.readthedocs.io/en/latest/model-code-config.html#cmake-build) in the documentation. ## Resources and Support For news and updates regarding the WRF-Hydro project please subscribe to our [email list](https://ral.ucar.edu/projects/wrf_hydro/subscribe).