Skip to content

Commit 093d987

Browse files
Ivorforcemaiself
authored andcommitted
Document the current state of releases on the docs.
1 parent 615a153 commit 093d987

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/usage/installation.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,19 @@ Other installation locations are also possible, but please keep the original lay
1111

1212
## From Godot's Asset Library
1313

14-
_To be written..._
14+
_godot-python is in early development and is not yet available on the Godot Asset Library._
1515

1616
## From GitHub releases
1717

18-
Visit the project's [releases page](https://github.com/maiself/godot-python-extension/releases) and download the archive for the version of the extension you need. Then extract the archive into the `addons/godot-python-extension` directory within your project.
18+
_godot-python is in early development and does not yet have an official release._
1919

20+
[//]: # (Visit the project's [releases page](https://github.com/maiself/godot-python-extension/releases) and download the archive for the version of the extension you need. Then extract the archive into the `addons/godot-python-extension` directory within your project.)
2021

21-
## As a submodule
22+
## From nightly builds (GitHub Actions)
23+
24+
You can download nightly builds from [GitHub Actions](https://github.com/maiself/godot-python-extension/actions). Keep in mind nightly builds may be unstable and are not recommended for production setups. Right now, they are also not packaged like regular release builds, and may not be usable out of the box.
25+
26+
## As a git submodule
2227

2328
To install a prebuilt version of the extension from the [`prebuilt-releases`](https://github.com/maiself/godot-python-extension/tree/prebuilt-releases) branch as a submodule in `addons/godot-python-extension`:
2429

@@ -39,7 +44,7 @@ To update the extension to a newer version run the submodule update command agai
3944
It is possible to create a submodule using a shallow checkout of [`prebuilt-releases`](https://github.com/maiself/godot-python-extension/tree/prebuilt-releases) that contains only binaries from the version actually needed, rather than all versions in the branch history.
4045

4146
```{caution}
42-
This method is more advanced than the others, and may not provide much benefit over a simple submodule as described in the [previous section](#as-a-submodule). A thorough understanding of Git's workings is strongly recommended if considering this method.
47+
This method is more advanced than the others, and may not provide much benefit over a simple submodule as described in the [previous section](#as-a-git-submodule). A thorough understanding of Git's workings is strongly recommended if considering this method.
4348
```
4449

4550
To initialize a shallow checkout of the [`prebuilt-releases`](https://github.com/maiself/godot-python-extension/tree/prebuilt-releases) branch as a submodule in `addons/godot-python-extension`:

0 commit comments

Comments
 (0)