Skip to content

Commit 9da1e0c

Browse files
authored
Merge pull request #1543 from Calinou/readme-use-github-admonition-syntax
Use GitHub admonition syntax for the warning in README
2 parents 3f4590f + 26459dc commit 9da1e0c

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# godot-cpp
22

3-
> **Warning**
3+
> [!WARNING]
44
>
55
> This repository's `master` branch is only usable with
66
> [GDExtension](https://godotengine.org/article/introducing-gd-extensions)
@@ -49,18 +49,20 @@ Godot version.**
4949
5050
## Compatibility
5151

52-
**Warning:** The GDExtension API is brand new in Godot 4.0, and is still
52+
> [!WARNING]
53+
>
54+
> The GDExtension API is brand new in Godot 4.0, and is still
5355
considered in **beta** stage, despite Godot 4.0 itself being released.
54-
55-
This applies to both the GDExtension interface header, the API JSON, and this
56+
>
57+
> This applies to both the GDExtension interface header, the API JSON, and this
5658
first-party `godot-cpp` extension.
57-
58-
Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
59-
get more used, documented, and critical issues get resolved. See the
60-
[Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension)
61-
and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues)
62-
for a list of known issues, and be sure to provide feedback on issues and PRs
63-
which affect your use of this extension.
59+
>
60+
> Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
61+
> get more used, documented, and critical issues get resolved. See the
62+
> [Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension)
63+
> and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues)
64+
> for a list of known issues, and be sure to provide feedback on issues and PRs
65+
> which affect your use of this extension.
6466
6567
## Contributing
6668

0 commit comments

Comments
 (0)