#96 Add instructions for using git submodules

This commit is contained in:
Jack 2023-12-31 14:24:19 +08:00
parent c7fe8bcd0f
commit 0d248d1c8e

View file

@ -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`