Skip to content

Commit 1588dc8

Browse files
committed
Clarify versions and examples in the README
1 parent a7d3f00 commit 1588dc8

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

+19-10
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22

33
> **Warning**
44
>
5-
> This repository's `master` branch is only usable with the latest version of
6-
> Godot's ([GDExtension](https://godotengine.org/article/introducing-gd-extensions))
7-
> API (Godot 4.1 and later).
5+
> This repository's `master` branch is only usable with
6+
> [GDExtension](https://godotengine.org/article/introducing-gd-extensions)
7+
> from Godot's `master` branch.
88
>
9-
> For users of Godot 4.0.x, switch to the [`4.0`](https://github.com/godotengine/godot-cpp/tree/4.0) branch.
9+
> For users of stable branches, switch to the branch matching your target Godot version:
10+
> - [`4.0`](https://github.com/godotengine/godot-cpp/tree/4.0)
11+
> - [`4.1`](https://github.com/godotengine/godot-cpp/tree/4.1)
12+
>
13+
> Or check out the Git tag matching your Godot version (e.g. `godot-4.1.1-stable`).
1014
>
1115
> For GDNative users (Godot 3.x), switch to the [`3.x`](https://github.com/godotengine/godot-cpp/tree/3.x)
1216
> or the [`3.5`](https://github.com/godotengine/godot-cpp/tree/3.5) branch.
@@ -52,9 +56,10 @@ first-party `godot-cpp` extension.
5256

5357
Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
5458
get more used, documented, and critical issues get resolved. See the
55-
[issue tracker](https://github.com/godotengine/godot/issues) for a list of known
56-
issues, and be sure to provide feedback on issues and PRs which affect your use
57-
of this extension.
59+
[Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension)
60+
and the [godot-cpp issue tracker](https://github.com/godotengine/godot/issues)
61+
for a list of known issues, and be sure to provide feedback on issues and PRs
62+
which affect your use of this extension.
5863

5964
## Contributing
6065

@@ -76,7 +81,7 @@ just like before.
7681

7782
To use the shared lib in your Godot project you'll need a `.gdextension`
7883
file, which replaces what was the `.gdnlib` before.
79-
Follow [the example](test/project/example.gdextension):
84+
See [example.gdextension](test/project/example.gdextension) used in the test project:
8085

8186
```ini
8287
[configuration]
@@ -129,6 +134,10 @@ void initialize_example_module(ModuleInitializationLevel p_level) {
129134

130135
Any node and resource you register will be available in the corresponding `Create...` dialog. Any class will be available to scripting as well.
131136

132-
## Included example
137+
## Examples and templates
138+
139+
See the [godot-cpp-template](https://github.com/godotengine/godot-cpp-template) project for a
140+
generic reusable template.
133141

134-
Check the project in the `test` folder for an example on how to use and register different things.
142+
Or checkout the code for the [Summator example](https://github.com/paddy-exe/GDExtensionSummator)
143+
as shown in the [official documentation](https://docs.godotengine.org/en/latest/tutorials/scripting/gdextension/gdextension_cpp_example.html).

0 commit comments

Comments
 (0)