godotengine/gdnative-demos
1
0
Fork 0
mirror of https://github.com/godotengine/gdnative-demos.git synced 2026-01-06 06:09:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README to document versioned branches

Browse Source 
And mention the need to initialize submodules.
This commit is contained in:
Rémi Verschelde
2022-02-24 10:43:18 +01:00
parent 05274f7ccf
commit 72f55b889a
1 changed files with 17 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

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