Added to README for user meeting docs

JezSw · Jul 30, 2024 · 7b29dbc · 7b29dbc
1 parent ad62eb3
commit 7b29dbc
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -14,6 +14,18 @@ merged.
 The documentation requires a python 3 installation and a few pip packages including 
 [Sphinx](https://pypi.python.org/pypi/Sphinx) and [sphinx_rtd_theme](https://pypi.python.org/pypi/sphinx_rtd_theme) Python packages.
 
+In case you don't have the appropriate git and python dependencies these can be installed if using Debian/apt using the following command. If using alternative setups this may need adapting appropriately 
+
+```
+apt update && apt install -y git python3 python3-pip python3.10-venv
+```
+
+You can then clone the nekRS repository.
+
+```
+git clone https://github.com/JezSw/nekRS.git
+```
+
 The recommended way to setup the build environment is to create a local venv and 
 then install the packages via the requirement.txt file.
 

diff --git a/doc/source/developer_guide/contributing.rst b/doc/source/developer_guide/contributing.rst
@@ -5,3 +5,5 @@ Contributing
 
 This page contains guidelines and tips for those wanting to contribute to the
 code of nekRS.
+
+.. mdinclude:: ../../README.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,5 @@ Contributing

		This page contains guidelines and tips for those wanting to contribute to the
		code of nekRS.

		.. mdinclude:: ../../README.md