Skip to content

Commit 6af5ed7

Browse files
committed
Update the readme for contributing a config file
1 parent 5e4c127 commit 6af5ed7

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,11 @@ All kinds of contributions are welcome. These include:
7575

7676
### How to contribute your own installation configurations
7777

78-
If you want to use the tool for a non-supported smartphone, the fastest way is to adapt an [existing config file](https://github.com/openandroidinstaller-dev/openandroidinstaller/tree/main/openandroidinstaller/assets/configs).
78+
If you want to use the tool for a non-supported smartphone, the fastest way is to adapt an [existing config file](https://github.com/openandroidinstaller-dev/openandroidinstaller/tree/main/openandroidinstaller/assets/configs). The file should be named after the `device code` of your device. This is in general the output by `adb shell getprop | grep ro.product.device` when the devices is connected to the computer. You can also get the device code by connecting the device to the computer and run OpenAndroidInstaller to detect the device.
79+
80+
**To test your config file with the executable** without using the developer setup, place it in the same directory as the executable. There it will be detected by name. After you created a config file and it works fine, you can open a pull request to make the file available to other users. Please also add the device to the supported devices table above.
81+
82+
#### Content of a config file
7983

8084
Every step in the config file corresponds to one view in the application. These steps should contain the following fields:
8185
- `title`: str; Describing the overall goal of the step. Will be displayed in the header of the view.
@@ -94,11 +98,6 @@ Every step in the config file corresponds to one view in the application. These
9498
- `allow_skip`: [OPTIONAL] boolean; If a skip button should be displayed to allow skipping this step. Can be useful when the bootloader is already unlocked.
9599
- `link`: [OPTIONAL] Link to use for the link button if type is `link_button_with_confirm`.
96100

97-
The file should be named after device name output by `adb shell getprop | grep ro.product.device` when the devices is connected to the computer. You can also get the device code by connecting the device to the computer and run OpenAndroidInstaller to detect the device.
98-
99-
To test your config file with the executable without using the developer setup, place it in the same directory as the executable. There it will be detected by name.
100-
After you created a config file and it works fine, you can open a pull request to make the file available to other users. Please also add the device to the supported devices table above.
101-
102101
### How to build the application for your platform
103102

104103
The executables for the OpenAndroidInstaller are build with [pyinstaller](https://pyinstaller.org/en/stable/index.html). You can create builds for MacOS or Linux with `make build-app`. For Windows the paths need to be modified. For now, you can have a look [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/v0.1.2-alpha/.github/workflows/manual-build-windows.yml#L22) on how it's done.

0 commit comments

Comments
 (0)