Skip to content

Commit d3b2a13

Browse files
azwhikaruazwhikaru
authored
Update README.md
1 parent 3cb8e73 commit d3b2a13

File tree

1 file changed

+50
-61
lines changed

1 file changed

+50
-61
lines changed

‎README.md‎

Lines changed: 50 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,96 @@
1-
# Use Github Action to compile Recovery
1+
## Automated TWRP compilation based on Github Action
22

3-
- Support TWRP, SHRP compilation and production
3+
## Advertising
44

5-
---
5+
1. OrangeFox is [here](https://github.com/azwhikaru/Action-OFRP-Builder)
66

7-
## Python 2 in Debian (Ubuntu) has been removed. If you are working on Android 8.1 and below, use *Recovery Build (Legacy)*
7+
## Notice
88

9-
---
9+
1. Github Actions service is **NOT** unlimited so to avoid waste, don't use unverified source code in this, the best used to automate builds of repositories that are already stabilized
1010

11-
## OrangeFox is [here](https://github.com/azwhikaru/Action-OFRP-Builder)
11+
2. Before you make any changes, make sure that the repository you are operating in belongs to you. **"Fork" if you want to commit code, otherwise use "Use this template"**
1212

13-
---
13+
3. issues and Pull Requests may **NOT** get a reply. If you think is really necessary, use email on my profile to contact me
1414

15-
## Report script issues only, questions about your device may not be responded
15+
4. Python 2 in Debian (Ubuntu) has been **removed**. If you are working on Android 8.1 and below, use *Recovery Build (Legacy)*
1616

17-
---
17+
5. Don't ask any questions about your source code, such as
18+
- No rule to make ...
19+
- Image ... out of size
1820

1921
## Thanks to
20-
- All contributors
2122

22-
---
23-
24-
## Release Notes
25-
```
26-
= 2022/10/28
27-
- OFRP manifest is changed, so not fully support OFRP now (if you can slove this, please submit a pull request!)
28-
29-
= 2022/07/08
30-
- TWRP and TWRP-based 5.X ~ 12.X are ***ALL COMPILED SUCCESSFULLY***
31-
32-
= 2022/07/06
33-
- Add support for 5.1 branch
34-
35-
= 2022/07/05
36-
- Updated to work with trees back to 6.0
37-
- Add conditionals to include common trees for syncing
38-
- Update README for SSH keys
39-
40-
= 2022/07/04
41-
- Updated to work with Android 12.1 AOSP minimal TWRP manifest
42-
43-
= 2022/05/29
44-
- Should work correctly with Android 11 based source code
45-
46-
= 2022/02/03
47-
- Due to the hardware resource limitation of GitHub action, this version cannot be compiled based on AOSP and other source codes of Android 11 and above. If necessary, please use local compilation
48-
49-
= 2021/10/29:
50-
- Refactored version 2.0
51-
- Completely reconstruct the use logic to reduce the difficulty of use
52-
- Optimize the parameter transfer part, now you can run multiple Workers at the same time
53-
```
54-
55-
-----
23+
All contributors
5624

5725
## Parameter Description
5826

59-
| Name | Description | Example |
60-
| ------------ | -------------------- | ------------ |
61-
| `MANIFEST_URL` | Source address | https://github.com/minimal-manifest-twrp/platform_manifest_twrp_aosp.git |
62-
| `MANIFEST_BRANCH` | Source branch | twrp-12.1 |
63-
| `DEVICE_TREE_URL` | Device address | https://github.com/TeamWin/android_device_asus_I003D |
64-
| `DEVICE_TREE_BRANCH` | Device branch | android-12.1 |
65-
| `DEVICE_PATH` | Device location | device/asus/I003D |
66-
| `COMMON_TREE_URL` | Common tree address | https://github.com/TeamWin/android_device_asus_sm8250-common |
67-
| `COMMON_PATH` | Common tree location | device/asus/sm8250-common |
68-
| `DEVICE_NAME` | Model name | I003D |
69-
| `MAKEFILE_NAME` | Makefile name | twrp_I003D |
70-
| `BUILD_TARGET` | Build Target Partition (boot/recovery/vendorboot) | recovery |
27+
| Name | Description | Example |
28+
| -------------------- | ------------------------------------------------- | ------------------------------------------------------------ |
29+
| `MANIFEST_URL` | Source address | https://github.com/minimal-manifest-twrp/platform_manifest_twrp_aosp.git |
30+
| `MANIFEST_BRANCH` | Source branch | twrp-12.1 |
31+
| `DEVICE_TREE_URL` | Device address | https://github.com/TeamWin/android_device_asus_I003D |
32+
| `DEVICE_TREE_BRANCH` | Device branch | android-12.1 |
33+
| `DEVICE_PATH` | Device location | device/asus/I003D |
34+
| `COMMON_TREE_URL` | Common tree address | https://github.com/TeamWin/android_device_asus_sm8250-common |
35+
| `COMMON_PATH` | Common tree location | device/asus/sm8250-common |
36+
| `DEVICE_NAME` | Model name | I003D |
37+
| `MAKEFILE_NAME` | Makefile name | twrp_I003D |
38+
| `BUILD_TARGET` | Build Target Partition (boot/recovery/vendorboot) | recovery |
7139

7240
-----
7341

7442
## How to use
43+
7544
```
7645
For example, your username is: JohnSmith
7746
```
78-
#### 1. Click 'Fork' in the upper right corner of this repository
47+
48+
#### 0. If you want to commit code, click 'Fork' in the upper right corner of this repository
49+
7950
![image](https://user-images.githubusercontent.com/37921907/177914706-c92476c5-7e14-4fb3-be94-0c8a11dae874.png)
51+
52+
#### 1. If you just want to use it simply, click 'Use this template' in the upper right corner of this repository
53+
54+
![image](https://github.com/azwhikaru/Action-TWRP-Builder/assets/37921907/fae6ce3c-bd4c-4bbe-8050-5dd29dff2522)
55+
8056
#### 2. After waiting for the automatic redirection, you will see your own username
57+
8158
![image](https://user-images.githubusercontent.com/37921907/177915106-5bde6fc9-303c-479e-b290-22b48efd1e4e.png)
59+
8260
#### 3. Change the [username and email](https://github.com/CaptainThrowback/Action-Recovery-Builder/blob/main/.github/workflows/Recovery%20Build.yml#L100-L101) in the workflow to reflect your Github credentials (optional)
61+
8362
## Setting up SSH Keys (optional)
63+
8464
#### 4. Go to Settings, then select Deploy keys and select "Add deploy key" button.
8565

8666
#### 5. On your Android device, install [Termux](https://github.com/termux/termux-app/releases)
8767

8868
#### 6. Install openssh in Termux and generate ssh keys. (Do not use passphrase for keys)
69+
8970
NOTE: When creating the deploy key for a repository like [email protected]:owner/repo.git or https://github.com/owner/repo, put that URL into the key comment. (Hint: Try ssh-keygen ... -C "[email protected]:owner/repo.git".)
9071
owner = your Github username
72+
9173
```
9274
pkg install openssh
9375
ssh-keygen -t ed25519 -C "[email protected]:owner/Action-Recovery-Builder.git"
9476
```
77+
9578
#### 7. Add the keys to your repo. In Termux, use the following commands:
79+
9680
```
9781
cd /data/data/com.termux/files/usr/etc/ssh
9882
cat ssh_host_ed25519_key.pub
9983
```
84+
10085
Select and copy the key then paste in the box for Key.
10186
You can name it whatever you choose for the title.
10287

10388
#### 8. Now to add your private ssh key. Back in Termux:
89+
10490
```
10591
cat ssh_host_ed25519_key
10692
```
93+
10794
Copy the output from Termux.
10895

10996
In your browser, select *Secrets* under the Security tab.
@@ -114,19 +101,21 @@ cat ssh_host_ed25519_key
114101
Then select Add secret.
115102

116103
## Building the Recovery
104+
117105
#### 9. Click 'Actions-Recovery Build'
106+
118107
![image](https://user-images.githubusercontent.com/37921907/177915304-8731ed80-1d49-48c9-9848-70d0ac8f2720.png)
108+
119109
#### 10. Click 'Run workflow' and fill in according to the above 'parameter description'
110+
120111
![image](https://user-images.githubusercontent.com/37921907/177915346-71c29149-78fb-4a00-996f-5d84ffc9eb8c.png)
112+
121113
#### 11. After filling in, click 'Run workflow' to start running
122114

123115
-----
124116

125117
## Compilation results
118+
126119
Can be downloaded at [Release](../../releases)
127120

128121
-----
129-
## Remark
130-
131-
#### TeamWin Recovery Project: https://github.com/minimal-manifest-twrp
132-
#### SKYHAWK Recovery Project: https://github.com/SHRP/manifest

0 commit comments

Comments
 (0)