Merge pull request #64 from TeaganKing/documentation

Add links to readme in documentation
NCAR · Feb 15, 2024 · a1790f9 · a1790f9
2 parents f74813e + 5290ddb
commit a1790f9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,4 +5,6 @@ CUPiD Documentation
    :maxdepth: 2
    :hidden:
 
-    Installation Guide <install.rst>
+    Installation Guide <install.rst>
+
+More details can be found in the main repository `README <https://github.com/TeaganKing/CUPiD/blob/main/README.md>`_ .
diff --git a/docs/install.rst b/docs/install.rst
@@ -1,2 +1,4 @@
 Installing CUPiD
-================
+================
+
+See `Installation instructions <https://github.com/TeaganKing/CUPiD/tree/main?tab=readme-ov-file#installing>`_ .