aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author Robert Clarke <clarke.john.robert@gmail.com>2023-01-29 08:13:39 +0100
committer Robert Clarke <clarke.john.robert@gmail.com>2023-01-29 08:21:13 +0100
commit4cf3da383acaddf1575a8cd564338dd34c3ed939 (patch)
tree86e87ca719b20ddde0d76f17be4058c5491fbf9f /README.md
parent934f51ffc7b60551cc70bc9a07f0823976346a27 (diff)
feat(docs): added git submodule command to build instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7f87e38..409c75d 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@ Main Repo for the OpenVic2 Project
## Build/Run Instructions
1. Install [Godot 4 Beta 16](https://downloads.tuxfamily.org/godotengine/4.0/beta16/) and [scons](https://scons.org/) for your system.
+2. Run the command `git submodule update --init --recursive` to retrieve all related submodules.
3. Run `scons` in the project root, you should see a libopenvic2 file in `game/bin/openvic2`.
4. Open with Godot 4 Beta 16, click import and navigate to the `game` directory.
5. Import and edit.