summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-01-19 13:55:01 +0100
committerRémi Verschelde <rverschelde@gmail.com>2023-01-19 13:55:01 +0100
commitb0f9ca7918c9ff66305a2cb39c5ce96176f01e83 (patch)
tree55a9d427fc3dab2dc3b517508946244d61374044 /README.md
parent2eb375e4861d7f21e0c827226a92cb876c76faf4 (diff)
parent624aeae2d34c4546eb91a53137b135678709bdd0 (diff)
downloadredot-cpp-b0f9ca7918c9ff66305a2cb39c5ce96176f01e83.tar.gz
Merge pull request #808 from Calinou/readme-add-branch-warning
Add a more prominent warning about repository branches in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index d1f0b9d..fd256a3 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,14 @@
# godot-cpp
+> **Warning**
+>
+> This repository's `master` branch is only usable with Godot 4.0 ([GDExtension](https://godotengine.org/article/introducing-gd-extensions)).
+>
+> Switch to the [`3.5` branch](https://github.com/godotengine/godot-cpp/tree/3.5)
+> if using Godot 3.5.x with GDNative,
+> or the [`3.x` branch](https://github.com/godotengine/godot-cpp/tree/3.x)
+> if using the Godot 3.x development branch with GDNative.
+
This repository contains the *C++ bindings* for the [**Godot Engine**](https://github.com/godotengine/godot)'s GDExtensions API.
- [**Versioning**](#versioning)