aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author CptAlanSmith <123112708+CptAlanSmith@users.noreply.github.com>2023-08-18 09:03:57 +0200
committer GitHub <noreply@github.com>2023-08-18 09:03:57 +0200
commit00426f3ab57e7a06a92f3aeac6466a403a933f80 (patch)
tree93a54903012223ca1dbe5648454bec9530901968 /README.md
parentaa9961b27a4859f088b037dd8037accb4e3119be (diff)
Update README.md
Added comments pointing to acquiring the code using git
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 96d871c..c0299e2 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,12 @@ For detailed instructions, view the Contributor Quickstart Guide [here](docs/con
* [Godot 4.1.1](https://github.com/godotengine/godot/releases/tag/4.1.1-stable)
* [scons](https://scons.org/)
+## Repo Setup
+1. Clone the OpenVic Repo to a suitable folder using the git command "git clone https://github.com/OpenVicProject/OpenVic.git"
+2. Update the submodules by executing the git command "git submodule update --init --recursive"
+
+Note that using a zip download instead of cloning means a lot of work in manually managing submodules individually. It is strongly recommended to use git to obtain the source code.
+
## [Godot Documentation](https://docs.godotengine.org/en/latest/)
## Build/Run Instructions