Skip to content

Commit 6fb8abd

Browse files
committed
Added formatting note to content
1 parent 03c99b9 commit 6fb8abd

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Every step in the config file corresponds to one view in the application. These
218218
- `call_button_with_input`: Display the content text, an input field and a button that runs a given command. The inputtext, can be used in the command by using the `<inputtext>` placeholder in the command field. After the command is run, a confirm button is displayed to allow the user to move to the next step.
219219
- `link_button_with_confirm`: Display a button that opens a browser with a given link, confirm afterwards. Link is given in `link`.
220220
- `img`: [OPTIONAL] Display an image on the left pane of the step view. Images are loaded from `openandroidinstaller/assets/imgs/`.
221-
- `content`: str; The content text displayed alongside the action of the step. Used to inform the user about whats going on.
221+
- `content`: str; The content text displayed alongside the action of the step. Used to inform the user about whats going on. For consistency and better readability the text should be moved into the next line using `>`.
222222
- `link`: [OPTIONAL] Link to use for the link button if type is `link_button_with_confirm`.
223223
- `command`: [ONLY for call_button* steps] str; The command to run. One of `adb_reboot`, `adb_reboot_bootloader`, `adb_reboot_download`, `adb_sideload`, `adb_twrp_wipe_and_install`, `adb_twrp_copy_partitions`, `fastboot_boot_recovery`, `fastboot_unlock_with_code`, `fastboot_unlock`, `fastboot_oem_unlock`, `fastboot_get_unlock_data`, `fastboot_reboot`, `heimdall_flash_recovery`.
224224
- `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.

0 commit comments

Comments
 (0)