Merge pull request #638 from xmos/xross-patch-2

Add SSH info to installation.rst
xmos · Sep 26, 2024 · 85ecd0d · 85ecd0d
2 parents 12a3a25 + 41c9358
commit 85ecd0d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/programming_guide/installation.rst b/doc/programming_guide/installation.rst
@@ -49,6 +49,8 @@ Clone the XCORE-IOT repository with the following command:
 
     git clone --recurse-submodules [email protected]:xmos/xcore_iot.git
 
+The submodules require SSH to be correctly configured, please refer to https://docs.github.com/en/authentication/connecting-to-github-with-ssh for more details.
+
 =================================
 Step 2. Install Host Applications
 =================================