From 72f55b889ad802b6b9d7ba5b58108d5fd920ba8a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= <rverschelde@gmail.com>
Date: Thu, 24 Feb 2022 10:43:18 +0100
Subject: [PATCH] Update README to document versioned branches

And mention the need to initialize submodules.
---
 README.md | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index ad17cb5..8b8cef9 100644
--- a/README.md
+++ b/README.md
@@ -5,13 +5,28 @@ Each folder inside of those is a GDNative project. Once compiled, the
 `project.godot` file can be opened with
 [Godot Engine](https://godotengine.org), the open source 2D and 3D game engine.
 
+**Important:** Each demo depends on submodules for the `godot-headers` and
+`godot-cpp` GDNative dependencies. You should initialize this repository by
+checking out the submodules recursively:
+
+```
+git submodule update --init --recursive
+```
+
 For non-GDNative demos (GDScript, VisualScript, and C#), please see the
 [Godot demo projects](https://github.com/godotengine/godot-demo-projects/) repo.
 
 ## Godot versions
 
-The [`master`](https://github.com/godotengine/gdnative-demos) branch
-is compatible with the latest stable Godot version (currently 3.3).
+The [`master`](https://github.com/godotengine/gdnative-demos/tree/master) branch
+is compatible with the `3.x` development branch of Godot.
+
+Numbered branches are compatible with the corresponding Godot branch.
+The following numbered branches are available:
+
+- [`3.3`](https://github.com/godotengine/gdnative-demos/tree/3.3)
+- [`3.4`](https://github.com/godotengine/gdnative-demos/tree/3.4)
+
 Older Godot versions are not supported by this repo.
 
 ## Useful links