From 8c4b5ddc625ff6eff94e53a2f03dbadf704abbfb Mon Sep 17 00:00:00 2001 From: Andrew Luchuk Date: Sat, 14 Mar 2026 18:57:26 -0400 Subject: [PATCH] Add section on git submodule --- readme.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/readme.md b/readme.md index affac55..b8b1815 100644 --- a/readme.md +++ b/readme.md @@ -13,6 +13,26 @@ To set up a repository using this template, simply click the "Use this template" repository. You will then be presented with a new repository wizard that will guide you through the remaining setup steps. +### Cloning the repository + +This template uses a [git submodule][3] to make it easier to use the correct version of the Redog GDExtension API. As a +result, you must use a slightly different process for cloning repositories generated with this template. If you haven't +cloned the repo yet, you can use the following command to get the submodules automatically: +```sh +git clone --recurse-submodules +``` + +If you have already cloned the repo, you can initialize the submodules by running the following two commands: +```sh +git submodule init +git submodule update +``` + +Or by running the combined command: +```sh +git submodule update --init +``` + ## Building the extension. To build projects created with this template, you will need to run `scons`. If you have not already setup your system