Skip to content

Commit d081e76

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

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
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
>
99
> For users of Godot 4.0.x, switch to the [`4.0`](https://github.com/godotengine/godot-cpp/tree/4.0) branch.
1010
>
11+
> For users of Godot 4.1.x, switch to the [`4.1`](https://github.com/godotengine/godot-cpp/tree/4.1) branch.
12+
>
1113
> For GDNative users (Godot 3.x), switch to the [`3.x`](https://github.com/godotengine/godot-cpp/tree/3.x)
1214
> or the [`3.5`](https://github.com/godotengine/godot-cpp/tree/3.5) branch.
1315
@@ -52,9 +54,10 @@ first-party `godot-cpp` extension.
5254

5355
Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
5456
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.
57+
[Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension)
58+
and the [godot-cpp issue tracker](https://github.com/godotengine/godot/issues)
59+
for a list of known issues, and be sure to provide feedback on issues and PRs
60+
which affect your use of this extension.
5861

5962
## Contributing
6063

@@ -76,7 +79,7 @@ just like before.
7679

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

8184
```ini
8285
[configuration]
@@ -129,6 +132,10 @@ void initialize_example_module(ModuleInitializationLevel p_level) {
129132

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

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

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

0 commit comments

Comments
 (0)