Add ssh info to readme

xmos · Sep 26, 2024 · 7885f28 · 7885f28
1 parent 74daaef
commit 7885f28
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,8 @@ Some dependent components are included as git submodules. These can be obtained
 
     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.
+
 ## Documentation
 
 See the [official documentation](https://www.xmos.ai/documentation/XM-014660-PC-2/html/) for more information including: