From 7edd6db0a6292377e5b7fbfeda391817660142d4 Mon Sep 17 00:00:00 2001 From: Michael Wathen Date: Mon, 26 Apr 2021 17:09:55 +0100 Subject: [PATCH] Updating README to point to read the docs (#11) --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 00261d5..749cfc7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ ![Tests](https://github.com/pmlmodelling/ersem/workflows/build-ersem/badge.svg) +[![Documentation Status](https://readthedocs.org/projects/ersem/badge/?version=latest)](https://ersem.readthedocs.io/en/latest/?badge=latest) # ERSEM @@ -8,6 +9,11 @@ biogeochemical cycling of carbon, nitrogen, phosphorus, silicon, oxygen and iron through pelagic and benthic ecosystems. +- **Installation Instructions:** conda: https://ersem.readthedocs.io/en/latest/tutorials/index.html#conda-installation, source: https://ersem.readthedocs.io/en/latest/developers/index.html +- **User Documentation & Example Usage:** https://ersem.readthedocs.io/en/latest/ +- **Automated Tests:** Run via GitHub Actions https://github.com/pmlmodelling/ersem/actions +- **Acknowledgements:** https://ersem.readthedocs.io/en/latest/acknowledgements.html +- **License:** https://ersem.readthedocs.io/en/latest/license.html # How to cite