From 0d248d1c8e6fb9fc3c23f7add7b0e570d294d6d7 Mon Sep 17 00:00:00 2001 From: Jack Date: Sun, 31 Dec 2023 14:24:19 +0800 Subject: [PATCH] #96 Add instructions for using git submodules --- BUILDING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index 2d94f09..e72835f 100644 --- 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`