Sara.Sync
/
godot-cpp
mirror of https://github.com/godotengine/godot-cpp
0
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use GitHub admonition syntax for the warning in README

pull/1543/head
Hugo Locurcio 2024-08-05 19:29:40 +02:00
parent daf6ad3649
commit 26459dc47b
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,6 +1,6 @@
# godot-cpp # godot-cpp
> **Warning** > [!WARNING]
> >
> This repository's `master` branch is only usable with > This repository's `master` branch is only usable with
> [GDExtension](https://godotengine.org/article/introducing-gd-extensions) > [GDExtension](https://godotengine.org/article/introducing-gd-extensions)
@ -49,18 +49,20 @@ Godot version.**
## Compatibility ## Compatibility
**Warning:** The GDExtension API is brand new in Godot 4.0, and is still > [!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. considered in **beta** stage, despite Godot 4.0 itself being released.
>
This applies to both the GDExtension interface header, the API JSON, and this > This applies to both the GDExtension interface header, the API JSON, and this
first-party `godot-cpp` extension. first-party `godot-cpp` extension.
>
Some compatibility breakage is to be expected as GDExtension and `godot-cpp` > Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
get more used, documented, and critical issues get resolved. See the > 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) > [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) > and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues)
for a list of known issues, and be sure to provide feedback on issues and PRs > for a list of known issues, and be sure to provide feedback on issues and PRs
which affect your use of this extension. > which affect your use of this extension.
## Contributing ## Contributing