#96 Add instructions for using git submodules

jakcron · Dec 31, 2023 · 0d248d1 · 0d248d1
1 parent c7fe8bc
commit 0d248d1
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/BUILDING.md b/BUILDING.md
@@ -1,4 +1,13 @@
 # Building
+## Git Submodules
+This project makes use of git submodules to import dependencies into the source tree.
+After cloning this repository using git, prior to building NSTool the dependencies need to be downloaded.
+Run these two commands to initialise and download the dependencies:
+```
+git submodule init
+git submodule update
+```
+
 ## Linux (incl. Windows Subsystem for Linux) & MacOS - Makefile
 ### Requirements
 * `make`