Skip to content

Commit 651e5be

Browse files
committed
Add README.md with some introduction
1 parent 751b302 commit 651e5be

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Godot in-container build scripts
2+
3+
Build scripts used for official Godot Engine releases using containers
4+
built from https://github.com/godotengine/build-containers
5+
6+
## Disclaimer
7+
8+
This repository is **not** intended for end users, and thus not
9+
supported. It's only public as a way to document our build workflow,
10+
and for anyone to use as reference for their own buildsystems.
11+
12+
We will eventually release a public build script that integrates all
13+
this in a simple and user-friendly interface.
14+
15+
## Usage
16+
17+
- Build containers using https://github.com/godotengine/build-containers
18+
- Copy `config.sh.in` as `config.sh` and configure it as you want.
19+
- Edit `build.sh` to properly reference those containers if local, or
20+
use `config.sh` to point to your own registry if you uploaded
21+
containers.
22+
- Build with `build.sh` (check `--help` for usage).
23+
- Package binaries with `build-release.sh` (check `--help` for usage).
24+
- Build templates .tpz with `build-templates.sh` (check `--help` for
25+
usage).
26+
27+
Example that builds Godot 3.2-stable Classical (not Mono):
28+
```
29+
./build.sh -v 3.2-stable -g 3.2-stable -b classical
30+
./build-release.sh -v 3.2-stable -b classical
31+
./build-templates.sh -v 3.2-stable -t 3.2.stable -b classical
32+
```
33+
34+
Again, this is intended for release managers and usability is not the
35+
main focus. Tweak the build scripts to match your own requirements if
36+
you want to use this until we provide a better, user-friendly
37+
interface.

0 commit comments

Comments
 (0)