diff --git a/README.md b/README.md index 005c8e72..6242acc4 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,9 @@ > > This repository's `master` branch is only usable with > [GDExtension](https://godotengine.org/article/introducing-gd-extensions) -> from Godot's `master` branch. -> -> For users of stable branches, switch to the branch matching your target Godot version: -> - [`4.2`](https://github.com/godotengine/godot-cpp/tree/4.2) -> - [`4.1`](https://github.com/godotengine/godot-cpp/tree/4.1) -> - [`4.0`](https://github.com/godotengine/godot-cpp/tree/4.0) -> -> Or check out the Git tag matching your Godot version (e.g. `godot-4.1.1-stable`). -> -> For GDNative users (Godot 3.x), switch to the [`3.x`](https://github.com/godotengine/godot-cpp/tree/3.x) -> or the [`3.5`](https://github.com/godotengine/godot-cpp/tree/3.5) branch. +> from Redot's `master` branch. -This repository contains the *C++ bindings* for the [**Godot Engine**](https://github.com/godotengine/godot)'s GDExtensions API. +This repository contains the *C++ bindings* for the [**Redot Engine**](https://github.com/Redot-Engine/redot-engine)'s GDExtensions API. - [**Versioning**](#versioning) - [**Compatibility**](#compatibility) @@ -31,9 +21,7 @@ repository](https://github.com/godotengine/godot): - `master` tracks the current GDExtension development branch for the next Godot 4.x minor release. -- `3.x` tracks the development of the GDNative plugin for the next 3.x minor - release. -- Other versioned branches (e.g. `4.0`, `3.5`) track the latest stable release +- Other versioned branches (e.g. `4.3`) track the latest stable release in the corresponding branch. Stable releases are also tagged on this repository: @@ -51,16 +39,18 @@ Godot version.** > [!WARNING] > -> The GDExtension API is brand new in Godot 4.0, and is still -considered in **beta** stage, despite Godot 4.0 itself being released. +> The GDExtension API is brand new since Godot 4.0, and is still +considered in **beta** stage, despite Redot 4.3 itself being released. > > This applies to both the GDExtension interface header, the API JSON, and this first-party `godot-cpp` extension. > > Some compatibility breakage is to be expected as GDExtension and `godot-cpp` > get more used, documented, and critical issues get resolved. See the -> [Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension) -> and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues) +> [Redot issue tracker](https://github.com/Redot-Engine/redot-engine/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension), +> the [Godot issue tracker](ttps://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension), +> the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues), +> and the [redot-cpp issue tracker](https://github.com/Redot-Engine/redot-cpp/issues) > for a list of known issues, and be sure to provide feedback on issues and PRs > which affect your use of this extension. @@ -78,7 +68,7 @@ so formatting is done before your changes are submitted. You need the same C++ pre-requisites installed that are required for the `godot` repository. Follow the [official build instructions for your target platform](https://docs.godotengine.org/en/latest/contributing/development/compiling/index.html#building-for-target-platforms). -Getting started with GDExtensions is a bit similar to what it was for 3.x but also a bit different. +Getting started with GDExtensions is a bit similar to what it was for Godot 3.x but also a bit different. This new approach is much more akin to how core Godot modules are structured. diff --git a/test/doc_classes/Example.xml b/test/doc_classes/Example.xml index 457709d5..741e6e89 100644 --- a/test/doc_classes/Example.xml +++ b/test/doc_classes/Example.xml @@ -1,5 +1,5 @@ - + A test control defined in GDExtension.