Skip to content

Commit

Permalink
document actions usage
Browse files Browse the repository at this point in the history
  • Loading branch information
haxibami committed Sep 20, 2024
1 parent e696d0f commit f7431b7
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
|<img width="1604" alt="screen shot 2017-08-07 at 12 18 15 pm" src="4.png"> |

# How to build the project

## Local

- install [Theos](https://github.com/theos/theos)
- install [Azule](https://github.com/Al4ise/Azule) if you want to build for sideload or TrollStore

Expand All @@ -52,12 +55,25 @@ chmod +x ./build.sh
./build.sh [OPTIONS]
```
- Replace [OPTIONS] with one of the following:
```--sideloaded: Build BHTwitter project for sideloaded deployment.

```
--sideloaded: Build BHTwitter project for sideloaded deployment.
--rootless: Build BHTwitter project for rootless deployment.
--trollstore: Build BHTwitter project for TrollStore deployment.
No option: Build BHTwitter project for rootfull deployment.
```

## Using GitHub Actions

- Fork this repository.
- Open "Actions" tab on your fork, and press "I understand my workflows, go ahead and enable them" to proceed.
- Select "Build and Release BHTwitter" workflow.
- Press "Run workflow" menu, and enter parameters in the popup that appears.
- Don't forget to choose deployment format (`rootfull`, `rootless`, `sideloaded`, `trollstore`).
- For `sideloaded` and `trollstore` builds, a valid URL of decrypted IPA is required. For `rootfull` and `rootless` builds, enter any value (it won't be used).
- For other parameters, defaults are usually sufficient.
- Press "Run workflow" button, and after a while you should see build artifacts on "Releases" page.

# Example Usages
## Build for Sideloaded Deployment
- Download an IPA file for X or Twitter from AppDB or decrypt it by your self.
Expand Down

0 comments on commit f7431b7

Please sign in to comment.