[SPLIT] Added optional device specific notes

README.md

@@ -210,11 +210,14 @@ A config file consists of two parts. The first part are some metadata about the
 ##### How to write Metadata
 Every config file should have `metadata` with the following fields:
 - `maintainer`: str; Maintainer and author of the config file.
+- `brand`: [OPTIONAL] str; Name of the brand. Can be used to make brand specific actions.
 - `device_name`: str; Name of the device.
 - `is_ab_device`: bool; A boolean to determine if the device is a/b-partitioned or not.
 - `device_code`: str; The official device code.
 - `supported_device_codes`: List[str]; A list of supported device codes for the config. The config will be loaded based on this field.
 - `twrp-link`: [OPTIONAL] str; name of the corresponding twrp page.
+- `notes`: [OPTIONAL] List[str]; specific phone information, showed before choosing ROM / recovery
+- `untested`: [OPTIONAL] bool; If `true`, a warning message is showed during installation process.
 
 In addition to these metadata, every config can have optional `requirements`. If these are set, the user is asked to check if they are meet.
 - `android`: [OPTIONAL] int|str; Android version to install prior to installing a custom ROM.

openandroidinstaller/installer_config.py

@@ -166,6 +166,7 @@ def validate_config(config: str) -> bool:
                 "device_code": str,
                 "supported_device_codes": [str],
                 schema.Optional("twrp-link"): str,
+                schema.Optional("notes"): str,
             },
             schema.Optional("requirements"): {
                 schema.Optional("android"): schema.Or(str, int),

openandroidinstaller/views/select_view.py

@@ -144,6 +144,29 @@ def build(self):
 
         # text row to show infos during the process
         self.info_field = Row()
+
+        # Device specific notes
+        notes = ""
+        if "brand" in self.state.config.metadata and (
+                self.state.config.metadata['brand'] == "xiaomi" or self.state.config.metadata['brand'] == "poco"):
+            notes += "- If something goes wrong, you can reinstall MiUI here :\n<https://xiaomifirmwareupdater.com/miui/lavender/>\n\n"
+        if "untested" in self.state.config.metadata and self.state.config.metadata['untested'] == True:
+            notes += "- **This device has never been tested with OpenAndroidInstaller.** The installation can go wrong. You may have to finish the installation process with command line. If you test, please report the result on GitHub.\n\n"
+        if "notes" in self.state.config.metadata:
+            for note in self.state.config.metadata['notes']:
+                notes += "- " + note + "\n\n"
+        if notes != "":
+            self.right_view.controls.extend(
+                [
+                    Text(
+                        "Important notes for your device",
+                        style="titleSmall",
+                        color=colors.RED,
+                        weight="bold",
+                    ),
+                    Markdown(f"""{notes}"""),
+                ]
+            )
         # if there is an available download, show the button to the page
         if self.download_link:
             twrp_download_link = f"https://dl.twrp.me/{self.state.config.twrp_link if self.state.config.twrp_link else self.state.config.device_code}"