Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[4.3] Fix README documentation issues #4

Merged
merged 1 commit into from
Nov 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 9 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,10 @@
> [!WARNING]
>
> This repository's `master` branch is only usable with
> [GDExtension](https://redotengine.org/article/introducing-gd-extensions)
> [GDExtension](https://godotengine.org/article/introducing-gd-extensions)
> from Redot's `master` branch.
>
> For users of stable branches, switch to the branch matching your target Redot version:
> - [`4.2`](https://github.com/Redot-Engine/redot-cpp/tree/4.2)
> - [`4.1`](https://github.com/Redot-Engine/redot-cpp/tree/4.1)
> - [`4.0`](https://github.com/Redot-Engine/redot-cpp/tree/4.0)
>
> Or check out the Git tag matching your Redot version (e.g. `redot-4.3-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.

This repository contains the *C++ bindings* for the [**Redot Engine**](https://github.com/Redot-Engine/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)
Expand All @@ -31,9 +21,7 @@ repository](https://github.com/Redot-Engine/redot-engine):

- `master` tracks the current GDExtension development branch for the next Redot
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:
Expand All @@ -51,15 +39,17 @@ Redot version.**

> [!WARNING]
>
> The GDExtension API is brand new in Redot 4.0, and is still
considered in **beta** stage, despite Redot 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 `redot-cpp` extension.
>
> Some compatibility breakage is to be expected as GDExtension and `redot-cpp`
> get more used, documented, and critical issues get resolved. See the
> [Redot issue tracker](https://github.com/Redot-Engine/redot-engine/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension)
> [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.
Expand All @@ -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 `redot-engine` repository. Follow the [official build instructions for your target platform](https://docs.redotengine.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 Redot modules are structured.

Expand Down
2 changes: 1 addition & 1 deletion test/doc_classes/Example.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Example" inherits="Control" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
<class name="Example" inherits="Control" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/Redot-Engine/redot-engine/master/doc/class.xsd">
<brief_description>
A test control defined in GDExtension.
</brief_description>
Expand Down
Loading