Skip to content

Commit 3f3eadd

Browse files
committed
Updated README with github_release descriptor example.
1 parent 75e3c30 commit 3f3eadd

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,24 @@ frameworks:
5959
- If you're using a local descriptor (dev or path) you need to build the PySide2 libraries
6060
yourself. See [building the PySide2 libraries locally](#building-the-pyside2-libraries-locally).
6161

62-
- If you're using a remote descriptor, just in time download must be added so these binaries are downloaded in SG TK bootstrap process. The provided [bootstrap.py](hooks/core/bootstrap.py) script implements just in time downloads from Github releases with a `git` descriptor:
62+
- If you're using a remote descriptor, just in time download must be added so these binaries are downloaded in SG TK bootstrap process. The provided [bootstrap.py](hooks/core/bootstrap.py) script implements just in time downloads from Github releases with a `git` or a `github_release` descriptor:
6363
- Copy the `hooks/core/bootstrap.py` file to your config `core/hooks/bootstrap.py`
6464
hook.
6565
- Use a `git` descriptor for the framework, e.g.:
6666
```
6767
tk-framework-unrealqt_v1.x.x:
6868
location:
69-
version: v1.2.5
69+
version: v1.3.0
7070
type: git
7171
path: [email protected]:ue4plugins/tk-framework-unrealqt.git
7272
```
73+
- Or use a `github_release` descriptor for the framework, e.g.:
74+
```
75+
tk-framework-unrealqt_v1.x.x:
76+
location:
77+
version: v1.3.0
78+
type: github_release
79+
organization: ue4plugins
80+
repository: tk-framework-unrealqt
81+
```
7382

0 commit comments

Comments
 (0)