From f57e787e02092b2a71f07cebdb591bbfe800cdff Mon Sep 17 00:00:00 2001 From: Saki <10335149+Saki-EU@users.noreply.github.com> Date: Fri, 1 Mar 2019 03:50:14 +0100 Subject: [PATCH] Formatting --- README.md | 124 +++++++++--------- ...k.md => About_Anti-Rollback_Protection.md} | 2 +- ...md => About_Fastboot_and_Recovery_ROMs.md} | 4 +- docs/{miui.md => About_MIUI.md} | 0 docs/{custom.md => About_custom_ROMs.md} | 2 +- docs/{edl.md => Access_EDL_mode.md} | 2 +- docs/{ads.md => Disable_ads_in_MIUI.md} | 2 +- docs/{camera2.md => Enable_Camera2.md} | 4 +- ...ations.md => Fix_notifications_on_MIUI.md} | 2 +- .../{sensorissues.md => Fix_sensor_issues.md} | 4 +- ...ustom.md => Flash_TWRP_and_custom_ROMs.md} | 8 +- ...lashofficial.md => Flash_official_ROMs.md} | 14 +- ...s.md => List_of_wired_Xiaomi_earphones.md} | 0 ...{resellers.md => Recommended_resellers.md} | 0 ...md => Regional_names_of_Xiaomi_devices.md} | 0 ...=> Regional_versions_of_Xiaomi_devices.md} | 0 docs/{tipsandtricks.md => Tips_and_tricks.md} | 8 +- .../{tools.md => Tools_for_Xiaomi_devices.md} | 0 ... => Tweak_the_China_ROM_for_global_use.md} | 4 +- ...systemapps.md => Uninstall_system_apps.md} | 2 +- ...bootloader.md => Unlock_the_bootloader.md} | 10 +- ...fy_the_authenticity_of_Xiaomi_products.md} | 0 docs/specs/{blackshark.md => Black_Shark.md} | 0 ...{blacksharkhelo.md => Black_Shark_Helo.md} | 0 docs/specs/{mi6.md => Mi_6.md} | 0 docs/specs/{mi6x.md => Mi_6X.md} | 0 docs/specs/{mi8.md => Mi_8.md} | 0 docs/specs/{mi8ee.md => Mi_8_EE.md} | 0 docs/specs/{mi8lite.md => Mi_8_Lite.md} | 0 docs/specs/{mi8pro.md => Mi_8_Pro.md} | 0 docs/specs/{mi8se.md => Mi_8_SE.md} | 0 docs/specs/{mi9.md => Mi_9.md} | 0 docs/specs/{mi9se.md => Mi_9_SE.md} | 0 docs/specs/{mia1.md => Mi_A1.md} | 0 docs/specs/{mia2.md => Mi_A2.md} | 0 docs/specs/{mia2lite.md => Mi_A2_Lite.md} | 0 docs/specs/{mimix2.md => Mi_MIX_2.md} | 0 docs/specs/{mimix2s.md => Mi_MIX_2S.md} | 0 docs/specs/{mimix3.md => Mi_MIX_3.md} | 0 docs/specs/{mimix35g.md => Mi_MIX_3_5G.md} | 0 docs/specs/{mimax2.md => Mi_Max_2.md} | 0 docs/specs/{mimax3.md => Mi_Max_3.md} | 0 docs/specs/{minote2.md => Mi_Note_2.md} | 0 docs/specs/{minote3.md => Mi_Note_3.md} | 0 docs/specs/{mipad3.md => Mi_Pad_3.md} | 0 docs/specs/{mipad4.md => Mi_Pad_4.md} | 0 .../specs/{mipad4plus.md => Mi_Pad_4_Plus.md} | 0 docs/specs/{miplay.md => Mi_Play.md} | 0 .../specs/{pocophonef1.md => POCOPHONE_F1.md} | 0 docs/specs/{redmi5.md => Redmi_5.md} | 0 docs/specs/{redmi5a.md => Redmi_5A.md} | 0 docs/specs/{redmi5plus.md => Redmi_5_Plus.md} | 0 docs/specs/{redmi6.md => Redmi_6.md} | 0 docs/specs/{redmi6a.md => Redmi_6A.md} | 0 docs/specs/{redmi6pro.md => Redmi_6_Pro.md} | 0 docs/specs/{redmigo.md => Redmi_Go.md} | 0 docs/specs/{redminote5.md => Redmi_Note_5.md} | 0 .../{redminote5a.md => Redmi_Note_5A.md} | 0 ...inote5aprime.md => Redmi_Note_5A_Prime.md} | 0 .../{redminote6pro.md => Redmi_Note_6_Pro.md} | 0 docs/specs/{redminote7.md => Redmi_Note_7.md} | 0 .../{redminote7pro.md => Redmi_Note_7_Pro.md} | 0 docs/specs/{redmis2.md => Redmi_S2.md} | 0 63 files changed, 96 insertions(+), 96 deletions(-) rename docs/{antirollback.md => About_Anti-Rollback_Protection.md} (98%) rename docs/{fastbootrecovery.md => About_Fastboot_and_Recovery_ROMs.md} (88%) rename docs/{miui.md => About_MIUI.md} (100%) rename docs/{custom.md => About_custom_ROMs.md} (99%) rename docs/{edl.md => Access_EDL_mode.md} (98%) rename docs/{ads.md => Disable_ads_in_MIUI.md} (91%) rename docs/{camera2.md => Enable_Camera2.md} (93%) rename docs/{notifications.md => Fix_notifications_on_MIUI.md} (95%) rename docs/{sensorissues.md => Fix_sensor_issues.md} (91%) rename docs/{flashcustom.md => Flash_TWRP_and_custom_ROMs.md} (96%) rename docs/{flashofficial.md => Flash_official_ROMs.md} (88%) rename docs/{earphones.md => List_of_wired_Xiaomi_earphones.md} (100%) rename docs/{resellers.md => Recommended_resellers.md} (100%) rename docs/{names.md => Regional_names_of_Xiaomi_devices.md} (100%) rename docs/{versions.md => Regional_versions_of_Xiaomi_devices.md} (100%) rename docs/{tipsandtricks.md => Tips_and_tricks.md} (65%) rename docs/{tools.md => Tools_for_Xiaomi_devices.md} (100%) rename docs/{chinarom.md => Tweak_the_China_ROM_for_global_use.md} (97%) rename docs/{systemapps.md => Uninstall_system_apps.md} (97%) rename docs/{bootloader.md => Unlock_the_bootloader.md} (89%) rename docs/{verify.md => Verify_the_authenticity_of_Xiaomi_products.md} (100%) rename docs/specs/{blackshark.md => Black_Shark.md} (100%) rename docs/specs/{blacksharkhelo.md => Black_Shark_Helo.md} (100%) rename docs/specs/{mi6.md => Mi_6.md} (100%) rename docs/specs/{mi6x.md => Mi_6X.md} (100%) rename docs/specs/{mi8.md => Mi_8.md} (100%) rename docs/specs/{mi8ee.md => Mi_8_EE.md} (100%) rename docs/specs/{mi8lite.md => Mi_8_Lite.md} (100%) rename docs/specs/{mi8pro.md => Mi_8_Pro.md} (100%) rename docs/specs/{mi8se.md => Mi_8_SE.md} (100%) rename docs/specs/{mi9.md => Mi_9.md} (100%) rename docs/specs/{mi9se.md => Mi_9_SE.md} (100%) rename docs/specs/{mia1.md => Mi_A1.md} (100%) rename docs/specs/{mia2.md => Mi_A2.md} (100%) rename docs/specs/{mia2lite.md => Mi_A2_Lite.md} (100%) rename docs/specs/{mimix2.md => Mi_MIX_2.md} (100%) rename docs/specs/{mimix2s.md => Mi_MIX_2S.md} (100%) rename docs/specs/{mimix3.md => Mi_MIX_3.md} (100%) rename docs/specs/{mimix35g.md => Mi_MIX_3_5G.md} (100%) rename docs/specs/{mimax2.md => Mi_Max_2.md} (100%) rename docs/specs/{mimax3.md => Mi_Max_3.md} (100%) rename docs/specs/{minote2.md => Mi_Note_2.md} (100%) rename docs/specs/{minote3.md => Mi_Note_3.md} (100%) rename docs/specs/{mipad3.md => Mi_Pad_3.md} (100%) rename docs/specs/{mipad4.md => Mi_Pad_4.md} (100%) rename docs/specs/{mipad4plus.md => Mi_Pad_4_Plus.md} (100%) rename docs/specs/{miplay.md => Mi_Play.md} (100%) rename docs/specs/{pocophonef1.md => POCOPHONE_F1.md} (100%) rename docs/specs/{redmi5.md => Redmi_5.md} (100%) rename docs/specs/{redmi5a.md => Redmi_5A.md} (100%) rename docs/specs/{redmi5plus.md => Redmi_5_Plus.md} (100%) rename docs/specs/{redmi6.md => Redmi_6.md} (100%) rename docs/specs/{redmi6a.md => Redmi_6A.md} (100%) rename docs/specs/{redmi6pro.md => Redmi_6_Pro.md} (100%) rename docs/specs/{redmigo.md => Redmi_Go.md} (100%) rename docs/specs/{redminote5.md => Redmi_Note_5.md} (100%) rename docs/specs/{redminote5a.md => Redmi_Note_5A.md} (100%) rename docs/specs/{redminote5aprime.md => Redmi_Note_5A_Prime.md} (100%) rename docs/specs/{redminote6pro.md => Redmi_Note_6_Pro.md} (100%) rename docs/specs/{redminote7.md => Redmi_Note_7.md} (100%) rename docs/specs/{redminote7pro.md => Redmi_Note_7_Pro.md} (100%) rename docs/specs/{redmis2.md => Redmi_S2.md} (100%) diff --git a/README.md b/README.md index b116051..14a07cf 100644 --- a/README.md +++ b/README.md @@ -2,83 +2,83 @@ ## Knowledge base -* [Tips & tricks](docs/tipsandtricks.md) -* [Recommended resellers](docs/resellers.md) -* [Regional names of Xiaomi devices](docs/names.md) -* [Regional versions of Xiaomi devices](docs/versions.md) -* [List of wired Xiaomi earphones](docs/earphones.md) -* [Verify the authenticity of Xiaomi products](docs/verify.md) +* [Tips & tricks](docs/Tips_and_tricks.md) +* [Recommended resellers](docs/Recommended_resellers.md) +* [Regional names of Xiaomi devices](docs/Regional_names_of_Xiaomi_devices.md) +* [Regional versions of Xiaomi devices](docs/Regional_versions_of_Xiaomi_devices.md) +* [List of wired Xiaomi earphones](docs/List_of_wired_Xiaomi_earphones.md) +* [Verify the authenticity of Xiaomi products](docs/Verify_the_authenticity_of_Xiaomi_products.md) --- -* [About MIUI](docs/miui.md) -* [About custom ROMs](docs/custom.md) -* [About Fastboot & Recovery ROMs](docs/fastbootrecovery.md) -* [About Anti-Rollback Protection](docs/antirollback.md) +* [About MIUI](docs/About_MIUI.md) +* [About custom ROMs](docs/About_custom_ROMs.md) +* [About Fastboot & Recovery ROMs](docs/About_Fastboot_and_Recovery_ROMs.md) +* [About Anti-Rollback Protection](docs/About_Anti-Rollback_Protection.md) ## Guides -[Tools for Xiaomi devices](docs/tools.md) +[Tools for Xiaomi devices](docs/Tools_for_Xiaomi_devices.md) ### Basic -* [Flash official ROMs](docs/flashofficial.md) -* [Uninstall system apps](docs/systemapps.md) -* [Disable ads in MIUI](docs/ads.md) -* [Optimise notifications on MIUI](docs/notifications.md) -* [Optimise the China ROM for use outside of China](docs/chinarom.md) +* [Flash official ROMs](docs/Flash_official_ROMs.md) +* [Uninstall system apps](docs/Uninstall_system_apps.md) +* [Disable ads in MIUI](docs/Disable_ads_in_MIUI.md) +* [Fix notifications on MIUI](docs/Fix_notifications_on_MIUI.md) +* [Tweak the China ROM for global use](docs/Tweak_the_China_ROM_for_global_use.md) ### Advanced -* [Unlock & lock the bootloader](docs/bootloader.md) -* [Flash TWRP & custom ROMs](docs/flashcustom.md) -* [Enable Camera2](docs/camera2.md) -* [Access EDL mode](docs/edl.md) -* [Fix sensor issues](docs/sensorissues.md) +* [Unlock the bootloader](docs/Unlock_the_bootloader.md) +* [Flash TWRP & custom ROMs](docs/Flash_TWRP_and_custom_ROMs.md) +* [Enable Camera2](docs/Enable_Camera2.md) +* [Access EDL mode](docs/Access_EDL_mode.md) +* [Fix sensor issues](docs/Fix_sensor_issues.md) ## Specs -* [Black Shark](docs/specs/blackshark.md) -* [Black Shark Helo](docs/specs/blacksharkhelo.md) -* [Mi 6](docs/specs/mi6.md) -* [Mi 6X](docs/specs/mi6x.md) -* [Mi 8](docs/specs/mi8.md) -* [Mi 8 Explorer Edition](docs/specs/mi8ee.md) -* [Mi 8 Lite](docs/specs/mi8lite.md) -* [Mi 8 Pro](docs/specs/mi8pro.md) -* [Mi 8 SE](docs/specs/mi8se.md) -* [Mi 9](docs/specs/mi9.md) -* [Mi 9 SE](docs/specs/mi9se.md) -* [Mi A1](docs/specs/mia1.md) -* [Mi A2](docs/specs/mia2.md) -* [Mi A2 Lite](docs/specs/mia2.md) -* [Mi MIX 2](docs/specs/mimix2.md) -* [Mi MIX 2S](docs/specs/mimix2s.md) -* [Mi MIX 3](docs/specs/mimix3.md) -* [Mi MIX 3 5G](docs/specs/mimix35g.md) -* [Mi Max 2](docs/specs/mimax2.md) -* [Mi Max 3](docs/specs/mimax3.md) -* [Mi Note 2](docs/specs/minote2.md) -* [Mi Note 3](docs/specs/minote3.md) -* [Mi Play](docs/specs/miplay.md) -* [POCOPHONE F1](docs/specs/pocophonef1.md) -* [Redmi 5](docs/specs/redmi5.md) -* [Redmi 5 Plus](docs/specs/redmi5plus.md) -* [Redmi 5A](docs/specs/redmi5a.md) -* [Redmi 6](docs/specs/redmi6.md) -* [Redmi 6 Pro](docs/specs/redmi6pro.md) -* [Redmi 6A](docs/specs/redmi6a.md) -* [Redmi Go](docs/specs/redmigo.md) -* [Redmi Note 5](docs/specs/redminote5.md) -* [Redmi Note 5A](docs/specs/redminote5a.md) -* [Redmi Note 5A Prime](docs/specs/redminote5aprime.md) -* [Redmi Note 6 Pro](docs/specs/redminote6pro.md) -* [Redmi Note 7](docs/specs/redminote7.md) -* [Redmi Note 7 Pro](docs/specs/redminote7pro.md) -* [Redmi S2](docs/specs/redmis2.md) +* [Black Shark](docs/specs/Black_Shark.md) +* [Black Shark Helo](docs/specs/Black_Shark_Helo.md) +* [Mi 6](docs/specs/Mi_6.md) +* [Mi 6X](docs/specs/Mi_6X.md) +* [Mi 8](docs/specs/Mi_8.md) +* [Mi 8 Explorer Edition](docs/specs/Mi_8_EE.md) +* [Mi 8 Lite](docs/specs/Mi_8_Lite.md) +* [Mi 8 Pro](docs/specs/Mi_8_Pro.md) +* [Mi 8 SE](docs/specs/Mi_8_SE.md) +* [Mi 9](docs/specs/Mi_9.md) +* [Mi 9 SE](docs/specs/Mi_9_SE.md) +* [Mi A1](docs/specs/Mi_A1.md) +* [Mi A2](docs/specs/Mi_A2.md) +* [Mi A2 Lite](docs/specs/Mi_A2_Lite.md) +* [Mi MIX 2](docs/specs/Mi_MIX_2.md) +* [Mi MIX 2S](docs/specs/Mi_MIX_2S.md) +* [Mi MIX 3](docs/specs/Mi_MIX_3.md) +* [Mi MIX 3 5G](docs/specs/Mi_MIX_3_5G.md) +* [Mi Max 2](docs/specs/Mi_Max_2.md) +* [Mi Max 3](docs/specs/Mi_Max_3.md) +* [Mi Note 2](docs/specs/Mi_Note_2.md) +* [Mi Note 3](docs/specs/Mi_Note_3.md) +* [Mi Play](docs/specs/Mi_Play.md) +* [POCOPHONE F1](docs/specs/POCOPHONE_F1.md) +* [Redmi 5](docs/specs/Redmi_5.md) +* [Redmi 5 Plus](docs/specs/Redmi_5_Plus.md) +* [Redmi 5A](docs/specs/Redmi_5A.md) +* [Redmi 6](docs/specs/Redmi_6.md) +* [Redmi 6 Pro](docs/specs/Redmi_6_Pro.md) +* [Redmi 6A](docs/specs/Redmi_6A.md) +* [Redmi Go](docs/specs/Redmi_Go.md) +* [Redmi Note 5](docs/specs/Redmi_Note_5.md) +* [Redmi Note 5A](docs/specs/Redmi_Note_5A.md) +* [Redmi Note 5A Prime](docs/specs/Redmi_Note_5A_Prime.md) +* [Redmi Note 6 Pro](docs/specs/Redmi_Note_6_Pro.md) +* [Redmi Note 7](docs/specs/Redmi_Note_7.md) +* [Redmi Note 7 Pro](docs/specs/Redmi_Note_7_Pro.md) +* [Redmi S2](docs/specs/Redmi_S2.md) --- -* [Mi Pad 3](docs/specs/mipad3.md) -* [Mi Pad 4](docs/specs/mipad4.md) -* [Mi Pad 4 Plus](docs/specs/mipad4plus.md) +* [Mi Pad 3](docs/specs/Mi_Pad_3.md) +* [Mi Pad 4](docs/specs/Mi_Pad_4.md) +* [Mi Pad 4 Plus](docs/specs/Mi_Pad_4_Plus.md) \ No newline at end of file diff --git a/docs/antirollback.md b/docs/About_Anti-Rollback_Protection.md similarity index 98% rename from docs/antirollback.md rename to docs/About_Anti-Rollback_Protection.md index b54b538..f2e982b 100644 --- a/docs/antirollback.md +++ b/docs/About_Anti-Rollback_Protection.md @@ -4,7 +4,7 @@ Anti-Rollback Protection (ARP) was introduced by Google in Android 8.0 (Oreo) an ### Checking if ARP is enabled -1. Download and launch the Xiaomi ADB/Fastboot Tools from [here](tools.md). +1. Download and launch the Xiaomi ADB/Fastboot Tools from [here](Tools_for_Xiaomi_devices.md). 2. Connect the device in Fastboot mode. See the instructions [here](https://saki-eu.github.io/XiaomiADBFastbootTools/). diff --git a/docs/fastbootrecovery.md b/docs/About_Fastboot_and_Recovery_ROMs.md similarity index 88% rename from docs/fastbootrecovery.md rename to docs/About_Fastboot_and_Recovery_ROMs.md index c2e5a49..92083a9 100644 --- a/docs/fastbootrecovery.md +++ b/docs/About_Fastboot_and_Recovery_ROMs.md @@ -6,6 +6,6 @@ The ROM packages you can flash on your device come in two formats: **Fastboot RO **Recovery ROMs** come in .zip files, they're lighter and contain images only for the most important partitions. Flashing a Recovery ROM isn't as clean as flashing a Fastboot ROM as it leaves many partitions untouched. -Official MIUI ROMs are available in the forms of [Fastboot ROMs](http://en.miui.com/a-234.html) and [Recovery ROMs](http://en.miui.com/download.html). Recovery ROMs can be flashed using MIUI itself or XiaomiADB, while Fastboot ROMs can be flashed using MiFlash or the Xiaomi ADB/Fastboot Tools and they also need an unlocked bootloader. More info [here](flashofficial.md). +Official MIUI ROMs are available in the forms of [Fastboot ROMs](http://en.miui.com/a-234.html) and [Recovery ROMs](http://en.miui.com/download.html). Recovery ROMs can be flashed using MIUI itself or XiaomiADB, while Fastboot ROMs can be flashed using MiFlash or the Xiaomi ADB/Fastboot Tools and they also need an unlocked bootloader. More info [here](Flash_official_ROMs.md). -Custom ROMs are available only in the form of Recovery ROMs and can only be flashed in TWRP. More info [here](flashcustom.md). \ No newline at end of file +Custom ROMs are available only in the form of Recovery ROMs and can only be flashed in TWRP. More info [here](Flash_TWRP_and_custom_ROMs.md). \ No newline at end of file diff --git a/docs/miui.md b/docs/About_MIUI.md similarity index 100% rename from docs/miui.md rename to docs/About_MIUI.md diff --git a/docs/custom.md b/docs/About_custom_ROMs.md similarity index 99% rename from docs/custom.md rename to docs/About_custom_ROMs.md index e7e97cd..8733e8c 100644 --- a/docs/custom.md +++ b/docs/About_custom_ROMs.md @@ -2,7 +2,7 @@ ### Reseller/vendor ROMs -Most Xiaomi devices, that are bought from unofficial sources, come with this type of ROM. They support many display languages and come with the Google Play Store, but often also with adware, spyware. These ROMs are unstable and unoptimised, because they are compiled from ROMs of other devices, so some things might not function properly and they might brick the device anytime. As such, **these ROMs are not safe to use** and it is highly recommended that you get rid of one as soon as possible. To do that, [flash your device in Fastboot mode](flashofficial.md). +Most Xiaomi devices, that are bought from unofficial sources, come with this type of ROM. They support many display languages and come with the Google Play Store, but often also with adware, spyware. These ROMs are unstable and unoptimised, because they are compiled from ROMs of other devices, so some things might not function properly and they might brick the device anytime. As such, **these ROMs are not safe to use** and it is highly recommended that you get rid of one as soon as possible. To do that, [flash your device in Fastboot mode](Flash_official_ROMs.md). **You have a reseller ROM if the following points apply:** diff --git a/docs/edl.md b/docs/Access_EDL_mode.md similarity index 98% rename from docs/edl.md rename to docs/Access_EDL_mode.md index a0b97c0..7e73660 100644 --- a/docs/edl.md +++ b/docs/Access_EDL_mode.md @@ -6,7 +6,7 @@ EDL (Emergency Download) mode is used in Qualcomm-based devices for unbricking/f ### ADB/Fastboot method -1. Download and launch the Xiaomi ADB/Fastboot Tools from [here](tools.md). +1. Download and launch the Xiaomi ADB/Fastboot Tools from [here](Tools_for_Xiaomi_devices.md). 2. Connect the device in ADB or Fastboot mode. See the instructions [here](https://saki-eu.github.io/XiaomiADBFastbootTools/). diff --git a/docs/ads.md b/docs/Disable_ads_in_MIUI.md similarity index 91% rename from docs/ads.md rename to docs/Disable_ads_in_MIUI.md index 99e9737..8461b69 100644 --- a/docs/ads.md +++ b/docs/Disable_ads_in_MIUI.md @@ -6,7 +6,7 @@ Advertising is an integral part of Xiaomi’s internet services, a key component 1. Uninstall MSA and every factory app you don't need or use. - Most factory apps cannot be uninstalled directly on the phone but you can use the [Xiaomi ADB/Fastboot Tools](systemapps.md) to remove them. + Most factory apps cannot be uninstalled directly on the phone but you can use the [Xiaomi ADB/Fastboot Tools](Uninstall_system_apps.md) to remove them. 2. Go to the settings of remaining Mi apps and disable recommendations. diff --git a/docs/camera2.md b/docs/Enable_Camera2.md similarity index 93% rename from docs/camera2.md rename to docs/Enable_Camera2.md index 8c3c0db..c5b0f2d 100644 --- a/docs/camera2.md +++ b/docs/Enable_Camera2.md @@ -4,7 +4,7 @@ Some camera apps on Android, like the modded Google Camera, use Android's [Camer ### Instructions -**Requirements:** [TWRP](flashcustom.md) +**Requirements:** [TWRP](Flash_TWRP_and_custom_ROMs.md) 1. Enter TWRP. @@ -12,7 +12,7 @@ Some camera apps on Android, like the modded Google Camera, use Android's [Camer 2. Keep the system read only, when asked. -3. Download and launch the Xiaomi ADB/Fastboot Tools from [here](tools.md). +3. Download and launch the Xiaomi ADB/Fastboot Tools from [here](Tools_for_Xiaomi_devices.md). 4. Connect the device to your computer. The application should detect it automatically. diff --git a/docs/notifications.md b/docs/Fix_notifications_on_MIUI.md similarity index 95% rename from docs/notifications.md rename to docs/Fix_notifications_on_MIUI.md index d35144f..e4d6b7d 100644 --- a/docs/notifications.md +++ b/docs/Fix_notifications_on_MIUI.md @@ -1,4 +1,4 @@ -## Optimise notifications on MIUI +## Fix notifications on MIUI MIUI likes to kill apps that run in the background to save battery life but many users don't like this strategy because this way they miss important notifications. Thankfully it's possible to disable most of these countermeasures. diff --git a/docs/sensorissues.md b/docs/Fix_sensor_issues.md similarity index 91% rename from docs/sensorissues.md rename to docs/Fix_sensor_issues.md index ec18ae7..675b331 100644 --- a/docs/sensorissues.md +++ b/docs/Fix_sensor_issues.md @@ -6,7 +6,7 @@ On Xiaomi devices, sensor data is stored in a partition called *persist*. This p **Requirements:** Qualcomm Snapdragon chipset -1. Download the latest MiFlash from [here](tools.md) and install it. +1. Download the latest MiFlash from [here](Tools_for_Xiaomi_devices.md) and install it. 2. Download the Fastboot ROM you want to flash from [here](http://en.miui.com/a-234.html) and unzip it. @@ -20,7 +20,7 @@ On Xiaomi devices, sensor data is stored in a partition called *persist*. This p 5. Save `rawprogram0.xml` and close the text editor. -6. Connect the device to your PC and [enter EDL mode](edl.md). +6. Connect the device to your PC and [enter EDL mode](Access_EDL_mode.md). 7. Launch MiFlash and with the Select button browse for the unzipped folder, then click Refresh. The device should appear as a COM port. diff --git a/docs/flashcustom.md b/docs/Flash_TWRP_and_custom_ROMs.md similarity index 96% rename from docs/flashcustom.md rename to docs/Flash_TWRP_and_custom_ROMs.md index a142aed..ccd1d39 100644 --- a/docs/flashcustom.md +++ b/docs/Flash_TWRP_and_custom_ROMs.md @@ -4,7 +4,7 @@ TWRP is a custom recovery that replaces MiRecovery / the splash screen for the M ### Use TWRP without flashing it -**Requirements:** [unlocked bootloader](bootloader.md) +**Requirements:** [unlocked bootloader](Unlock_the_bootloader.md) 1. Download and if needed, unzip the image file of the recovery that you want to flash. If a custom ROM requires a specific build of TWRP to be flashed, that is noted by the developer on XDA. @@ -14,7 +14,7 @@ TWRP is a custom recovery that replaces MiRecovery / the splash screen for the M [Unofficial TWRP builds](https://www.androidfilehost.com/?w=files&flid=50678) -2. Download and launch the Xiaomi ADB/Fastboot Tools from [here](tools.md). +2. Download and launch the Xiaomi ADB/Fastboot Tools from [here](Tools_for_Xiaomi_devices.md). 3. Connect the device in Fastboot mode. See the instructions [here](https://saki-eu.github.io/XiaomiADBFastbootTools/). @@ -28,7 +28,7 @@ TWRP is a custom recovery that replaces MiRecovery / the splash screen for the M ### Flash TWRP -**Requirements:** [unlocked bootloader](bootloader.md) +**Requirements:** [unlocked bootloader](Unlock_the_bootloader.md) **Note:** These instructions don't apply to Android One devices. @@ -40,7 +40,7 @@ TWRP is a custom recovery that replaces MiRecovery / the splash screen for the M [Unofficial TWRP builds](https://www.androidfilehost.com/?w=files&flid=50678) -2. Download and launch the Xiaomi ADB/Fastboot Tools from [here](tools.md). +2. Download and launch the Xiaomi ADB/Fastboot Tools from [here](Tools_for_Xiaomi_devices.md). 3. Connect the device in Fastboot mode. See the instructions [here](https://saki-eu.github.io/XiaomiADBFastbootTools/). diff --git a/docs/flashofficial.md b/docs/Flash_official_ROMs.md similarity index 88% rename from docs/flashofficial.md rename to docs/Flash_official_ROMs.md index 6fc7e17..9d689c5 100644 --- a/docs/flashofficial.md +++ b/docs/Flash_official_ROMs.md @@ -12,7 +12,7 @@ ### Flash Recovery ROMs in Recovery mode using XiaomiADB -1. Download and unzip XiaomiADB from [here](tools.md). +1. Download and unzip XiaomiADB from [here](Tools_for_Xiaomi_devices.md). 2. Download the Recovery ROM you want to flash from [here](http://en.miui.com/download.html). @@ -30,9 +30,9 @@ ### Flash Fastboot ROMs in Fastboot mode using the Xiaomi ADB/Fastboot Tools -**Requirements:** [unlocked bootloader](bootloader.md) +**Requirements:** [unlocked bootloader](Unlock_the_bootloader.md) -1. Download the Xiaomi ADB/Fastboot Tools from [here](tools.md). +1. Download the Xiaomi ADB/Fastboot Tools from [here](Tools_for_Xiaomi_devices.md). 2. Connect the device in Fastboot mode. See the instructions [here](https://saki-eu.github.io/XiaomiADBFastbootTools/). @@ -50,9 +50,9 @@ ### Flash Fastboot ROMs in Fastboot mode using MiFlash -**Requirements:** [unlocked bootloader](bootloader.md) +**Requirements:** [unlocked bootloader](Unlock_the_bootloader.md) -1. Download the latest MiFlash from [here](tools.md) and install it. +1. Download the latest MiFlash from [here](Tools_for_Xiaomi_devices.md) and install it. 2. Download the Fastboot ROM you want to flash from [here](http://en.miui.com/a-234.html) and unzip it. @@ -78,7 +78,7 @@ ### Flash Fastboot ROMs in EDL mode using MiFlash -1. Download the latest MiFlash from [here](tools.md) and install it. +1. Download the latest MiFlash from [here](Tools_for_Xiaomi_devices.md) and install it. 2. Launch MiFlash, install the necessary drivers by clicking Driver > Install/Reinstall in the top menu then reboot your PC. @@ -86,7 +86,7 @@ **Note:** You might get a single .tar file after unzipping which has to be unzipped again in order to get the necessary files. -4. Connect the device to your PC and enter EDL mode by following the instructions [here](edl.md). +4. Connect the device to your PC and enter EDL mode by following the instructions [here](Access_EDL_mode.md). 5. Launch MiFlash and browse for the unzipped folder by clicking the Select button. Make sure the file path has no spaces in it! diff --git a/docs/earphones.md b/docs/List_of_wired_Xiaomi_earphones.md similarity index 100% rename from docs/earphones.md rename to docs/List_of_wired_Xiaomi_earphones.md diff --git a/docs/resellers.md b/docs/Recommended_resellers.md similarity index 100% rename from docs/resellers.md rename to docs/Recommended_resellers.md diff --git a/docs/names.md b/docs/Regional_names_of_Xiaomi_devices.md similarity index 100% rename from docs/names.md rename to docs/Regional_names_of_Xiaomi_devices.md diff --git a/docs/versions.md b/docs/Regional_versions_of_Xiaomi_devices.md similarity index 100% rename from docs/versions.md rename to docs/Regional_versions_of_Xiaomi_devices.md diff --git a/docs/tipsandtricks.md b/docs/Tips_and_tricks.md similarity index 65% rename from docs/tipsandtricks.md rename to docs/Tips_and_tricks.md index 032abb8..d870cee 100644 --- a/docs/tipsandtricks.md +++ b/docs/Tips_and_tricks.md @@ -2,9 +2,9 @@ ### Before purchasing -* If you live outside of Xiaomi's official market, you have to purchase from third-party resellers who are sometimes more expensive, less reliable and don't provide as much aftersales as Xiaomi officially would. The list of recommended resellers can be found [here](resellers.md). +* If you live outside of Xiaomi's official market, you have to purchase from third-party resellers who are sometimes more expensive, less reliable and don't provide as much aftersales as Xiaomi officially would. The list of recommended resellers can be found [here](Recommended_resellers.md). -* Do not buy a [Chinese Version](versions.md) phone, even if it comes with the Global ROM pre-installed. Chinese Versions are made for the Chinese market and they primarily support Chinese networks so you probably won't get full network coverage in your country. Most models have Global Versions however, which support additional LTE bands, giving you better or even full network coverage. Moreover, it's not possible to boot Global MIUI on locked Chinese Versions and Global MIUI requires a locked bootloader to pass SafetyNet and get Google Play certification. Finally, Xiaomi rarely releases Global ROMs for devices only marketed in Mainland China and Chinese ROMs are difficult to set up and use outside of China, so if you want a Global ROM, wait for the [Global Version](versions.md) to come out. +* Do not buy a [Chinese Version](Regional_versions_of_Xiaomi_devices.md) phone, even if it comes with the Global ROM pre-installed. Chinese Versions are made for the Chinese market and they primarily support Chinese networks so you probably won't get full network coverage in your country. Most models have Global Versions however, which support additional LTE bands, giving you better or even full network coverage. Moreover, it's not possible to boot Global MIUI on locked Chinese Versions and Global MIUI requires a locked bootloader to pass SafetyNet and get Google Play certification. Finally, Xiaomi rarely releases Global ROMs for devices only marketed in Mainland China and Chinese ROMs are difficult to set up and use outside of China, so if you want a Global ROM, wait for the [Global Version](Regional_versions_of_Xiaomi_devices.md) to come out. * If you purchase a Chinese device with MIUI from a reseller, it might come with a reseller ROM if there's no official Global ROM available for it at the time of purchase. These ROMs are badly optimised, buggy, not safe to use and often bloated. If you encounter a reseller ROM, you have to get rid of it by yourself. Learn more about reseller ROMs [here](custom.md). @@ -16,6 +16,6 @@ * During the first time setup, it's recommended to create a Mi account but there's no need to use Xiaomi's own services, such as Find my device or MiCloud. The former makes it difficult to untie your device from your Mi account in case you want to reset it or sell it while the latter is simply inferior to Google Drive. -* MIUI comes with plenty of pre-installed apps that many users see as bloatware. Some of them can be easily uninstalled but most can't. If you'd like to get rid of such apps, look into my [uninstalling guide](systemapps.md). +* MIUI comes with plenty of pre-installed apps that many users see as bloatware. Some of them can be easily uninstalled but most can't. If you'd like to get rid of such apps, look into my [uninstalling guide](Uninstall_system_apps.md). -* Apps are often killed in the background by MIUI to prolong battery life and as a result you might not receive all your notifications by default. To fix that, change [these settings](notifications.md). \ No newline at end of file +* Apps are often killed in the background by MIUI to prolong battery life and as a result you might not receive all your notifications by default. To fix that, change [these settings](Fix_notifications_on_MIUI.md). \ No newline at end of file diff --git a/docs/tools.md b/docs/Tools_for_Xiaomi_devices.md similarity index 100% rename from docs/tools.md rename to docs/Tools_for_Xiaomi_devices.md diff --git a/docs/chinarom.md b/docs/Tweak_the_China_ROM_for_global_use.md similarity index 97% rename from docs/chinarom.md rename to docs/Tweak_the_China_ROM_for_global_use.md index 23d018c..c08708a 100644 --- a/docs/chinarom.md +++ b/docs/Tweak_the_China_ROM_for_global_use.md @@ -1,4 +1,4 @@ -## Optimise the China ROM for use outside of China +## Tweak the China ROM for global use There are a couple of Xiaomi devices that don't have official Global ROMs available. The best solution for these devices is installing the Xiaomi.eu ROM which is a debloated and optimised China ROM with Google Play, suitable for Western use. However, since it's a custom ROM, installing it requires an unlocked bootloader and TWRP. Unlocking the bootloader and flashing TWRP might be lengthy and annoying, so it's understandable if someone wants to keep using their device on the China ROM temporarily, or all the time because they aren't interested in flashing custom ROMs. Thankfully there are several ways to make the China ROM more pleasant to use for global users. @@ -10,7 +10,7 @@ There are a couple of Xiaomi devices that don't have official Global ROMs availa Alternatively, tap Uninstall on the top, check all the apps and uninstall them. -* You can uninstall most other systems apps using the [Xiaomi ADB/Fastboot Tools](systemapps.md). +* You can uninstall most other systems apps using the [Xiaomi ADB/Fastboot Tools](Uninstall_system_apps.md). ### Install the Google Play Store diff --git a/docs/systemapps.md b/docs/Uninstall_system_apps.md similarity index 97% rename from docs/systemapps.md rename to docs/Uninstall_system_apps.md index 41f9af0..64bb4ca 100644 --- a/docs/systemapps.md +++ b/docs/Uninstall_system_apps.md @@ -4,7 +4,7 @@ By default, MIUI comes with a lot of system apps that replace stock Android's ow ### Instructions -1. Download and launch the Xiaomi ADB/Fastboot Tools from [here](tools.md). +1. Download and launch the Xiaomi ADB/Fastboot Tools from [here](Tools_for_Xiaomi_devices.md). 2. Connect the device in ADB mode. See the instructions [here](https://saki-eu.github.io/XiaomiADBFastbootTools/). diff --git a/docs/bootloader.md b/docs/Unlock_the_bootloader.md similarity index 89% rename from docs/bootloader.md rename to docs/Unlock_the_bootloader.md index 1e66f99..33d793e 100644 --- a/docs/bootloader.md +++ b/docs/Unlock_the_bootloader.md @@ -1,4 +1,4 @@ -## Unlock & lock the bootloader +## Unlock the bootloader Starting with the Redmi Note 3 MTK, Xiaomi decided to lock its devices' bootloaders. As such, recent devices come with locked bootloaders out of the box. A locked bootloader prevents the user from flashing things in fastboot mode, including flashing custom recovery modes and custom ROMs. Fastboot mode **is** the bootloader, so if it is locked, changes to the device cannot be made in this mode. @@ -12,7 +12,7 @@ Starting with the Redmi Note 3 MTK, Xiaomi decided to lock its devices' bootload **You will only be able to proceed if it's been more than 72 or 360 hours that you successfully added your account and device. The waiting time depends on the phone model, you can check how much time is remaining by attempting to unlock.** -4. Download, extract and run [MiUnlock](tools.md). +4. Download, extract and run [MiUnlock](Tools_for_Xiaomi_devices.md). 5. Log in with your Mi account. @@ -28,7 +28,7 @@ Starting with the Redmi Note 3 MTK, Xiaomi decided to lock its devices' bootload 2. Go to Settings > System > Developer options and enable OEM unlocking. -3. Download and launch the Xiaomi ADB/Fastboot Tools from [here](tools.md). +3. Download and launch the Xiaomi ADB/Fastboot Tools from [here](Tools_for_Xiaomi_devices.md). 4. Connect the device in Fastboot mode. See the instructions [here](https://saki-eu.github.io/XiaomiADBFastbootTools/). @@ -38,10 +38,10 @@ Starting with the Redmi Note 3 MTK, Xiaomi decided to lock its devices' bootload ### Locking and re-unlocking the bootloader -To lock the bootloader, the device has to be clean installed in Fastboot mode. For the instructions, see [this page](flashofficial.md). +To lock the bootloader, the device has to be clean installed in Fastboot mode. For the instructions, see [this page](Flash_official_ROMs.md). Once a device has been unlocked, it can be locked and re-unlocked using the same account countless of times, anytime, on any official or custom ROM. ### Troubleshooting -If you keep getting an error message when trying to add your account and device in developer options, move to a Developer ROM. See the instructions [here](flashofficial.md). \ No newline at end of file +If you keep getting an error message when trying to add your account and device in developer options, move to a Developer ROM. See the instructions [here](Flash_official_ROMs.md). \ No newline at end of file diff --git a/docs/verify.md b/docs/Verify_the_authenticity_of_Xiaomi_products.md similarity index 100% rename from docs/verify.md rename to docs/Verify_the_authenticity_of_Xiaomi_products.md diff --git a/docs/specs/blackshark.md b/docs/specs/Black_Shark.md similarity index 100% rename from docs/specs/blackshark.md rename to docs/specs/Black_Shark.md diff --git a/docs/specs/blacksharkhelo.md b/docs/specs/Black_Shark_Helo.md similarity index 100% rename from docs/specs/blacksharkhelo.md rename to docs/specs/Black_Shark_Helo.md diff --git a/docs/specs/mi6.md b/docs/specs/Mi_6.md similarity index 100% rename from docs/specs/mi6.md rename to docs/specs/Mi_6.md diff --git a/docs/specs/mi6x.md b/docs/specs/Mi_6X.md similarity index 100% rename from docs/specs/mi6x.md rename to docs/specs/Mi_6X.md diff --git a/docs/specs/mi8.md b/docs/specs/Mi_8.md similarity index 100% rename from docs/specs/mi8.md rename to docs/specs/Mi_8.md diff --git a/docs/specs/mi8ee.md b/docs/specs/Mi_8_EE.md similarity index 100% rename from docs/specs/mi8ee.md rename to docs/specs/Mi_8_EE.md diff --git a/docs/specs/mi8lite.md b/docs/specs/Mi_8_Lite.md similarity index 100% rename from docs/specs/mi8lite.md rename to docs/specs/Mi_8_Lite.md diff --git a/docs/specs/mi8pro.md b/docs/specs/Mi_8_Pro.md similarity index 100% rename from docs/specs/mi8pro.md rename to docs/specs/Mi_8_Pro.md diff --git a/docs/specs/mi8se.md b/docs/specs/Mi_8_SE.md similarity index 100% rename from docs/specs/mi8se.md rename to docs/specs/Mi_8_SE.md diff --git a/docs/specs/mi9.md b/docs/specs/Mi_9.md similarity index 100% rename from docs/specs/mi9.md rename to docs/specs/Mi_9.md diff --git a/docs/specs/mi9se.md b/docs/specs/Mi_9_SE.md similarity index 100% rename from docs/specs/mi9se.md rename to docs/specs/Mi_9_SE.md diff --git a/docs/specs/mia1.md b/docs/specs/Mi_A1.md similarity index 100% rename from docs/specs/mia1.md rename to docs/specs/Mi_A1.md diff --git a/docs/specs/mia2.md b/docs/specs/Mi_A2.md similarity index 100% rename from docs/specs/mia2.md rename to docs/specs/Mi_A2.md diff --git a/docs/specs/mia2lite.md b/docs/specs/Mi_A2_Lite.md similarity index 100% rename from docs/specs/mia2lite.md rename to docs/specs/Mi_A2_Lite.md diff --git a/docs/specs/mimix2.md b/docs/specs/Mi_MIX_2.md similarity index 100% rename from docs/specs/mimix2.md rename to docs/specs/Mi_MIX_2.md diff --git a/docs/specs/mimix2s.md b/docs/specs/Mi_MIX_2S.md similarity index 100% rename from docs/specs/mimix2s.md rename to docs/specs/Mi_MIX_2S.md diff --git a/docs/specs/mimix3.md b/docs/specs/Mi_MIX_3.md similarity index 100% rename from docs/specs/mimix3.md rename to docs/specs/Mi_MIX_3.md diff --git a/docs/specs/mimix35g.md b/docs/specs/Mi_MIX_3_5G.md similarity index 100% rename from docs/specs/mimix35g.md rename to docs/specs/Mi_MIX_3_5G.md diff --git a/docs/specs/mimax2.md b/docs/specs/Mi_Max_2.md similarity index 100% rename from docs/specs/mimax2.md rename to docs/specs/Mi_Max_2.md diff --git a/docs/specs/mimax3.md b/docs/specs/Mi_Max_3.md similarity index 100% rename from docs/specs/mimax3.md rename to docs/specs/Mi_Max_3.md diff --git a/docs/specs/minote2.md b/docs/specs/Mi_Note_2.md similarity index 100% rename from docs/specs/minote2.md rename to docs/specs/Mi_Note_2.md diff --git a/docs/specs/minote3.md b/docs/specs/Mi_Note_3.md similarity index 100% rename from docs/specs/minote3.md rename to docs/specs/Mi_Note_3.md diff --git a/docs/specs/mipad3.md b/docs/specs/Mi_Pad_3.md similarity index 100% rename from docs/specs/mipad3.md rename to docs/specs/Mi_Pad_3.md diff --git a/docs/specs/mipad4.md b/docs/specs/Mi_Pad_4.md similarity index 100% rename from docs/specs/mipad4.md rename to docs/specs/Mi_Pad_4.md diff --git a/docs/specs/mipad4plus.md b/docs/specs/Mi_Pad_4_Plus.md similarity index 100% rename from docs/specs/mipad4plus.md rename to docs/specs/Mi_Pad_4_Plus.md diff --git a/docs/specs/miplay.md b/docs/specs/Mi_Play.md similarity index 100% rename from docs/specs/miplay.md rename to docs/specs/Mi_Play.md diff --git a/docs/specs/pocophonef1.md b/docs/specs/POCOPHONE_F1.md similarity index 100% rename from docs/specs/pocophonef1.md rename to docs/specs/POCOPHONE_F1.md diff --git a/docs/specs/redmi5.md b/docs/specs/Redmi_5.md similarity index 100% rename from docs/specs/redmi5.md rename to docs/specs/Redmi_5.md diff --git a/docs/specs/redmi5a.md b/docs/specs/Redmi_5A.md similarity index 100% rename from docs/specs/redmi5a.md rename to docs/specs/Redmi_5A.md diff --git a/docs/specs/redmi5plus.md b/docs/specs/Redmi_5_Plus.md similarity index 100% rename from docs/specs/redmi5plus.md rename to docs/specs/Redmi_5_Plus.md diff --git a/docs/specs/redmi6.md b/docs/specs/Redmi_6.md similarity index 100% rename from docs/specs/redmi6.md rename to docs/specs/Redmi_6.md diff --git a/docs/specs/redmi6a.md b/docs/specs/Redmi_6A.md similarity index 100% rename from docs/specs/redmi6a.md rename to docs/specs/Redmi_6A.md diff --git a/docs/specs/redmi6pro.md b/docs/specs/Redmi_6_Pro.md similarity index 100% rename from docs/specs/redmi6pro.md rename to docs/specs/Redmi_6_Pro.md diff --git a/docs/specs/redmigo.md b/docs/specs/Redmi_Go.md similarity index 100% rename from docs/specs/redmigo.md rename to docs/specs/Redmi_Go.md diff --git a/docs/specs/redminote5.md b/docs/specs/Redmi_Note_5.md similarity index 100% rename from docs/specs/redminote5.md rename to docs/specs/Redmi_Note_5.md diff --git a/docs/specs/redminote5a.md b/docs/specs/Redmi_Note_5A.md similarity index 100% rename from docs/specs/redminote5a.md rename to docs/specs/Redmi_Note_5A.md diff --git a/docs/specs/redminote5aprime.md b/docs/specs/Redmi_Note_5A_Prime.md similarity index 100% rename from docs/specs/redminote5aprime.md rename to docs/specs/Redmi_Note_5A_Prime.md diff --git a/docs/specs/redminote6pro.md b/docs/specs/Redmi_Note_6_Pro.md similarity index 100% rename from docs/specs/redminote6pro.md rename to docs/specs/Redmi_Note_6_Pro.md diff --git a/docs/specs/redminote7.md b/docs/specs/Redmi_Note_7.md similarity index 100% rename from docs/specs/redminote7.md rename to docs/specs/Redmi_Note_7.md diff --git a/docs/specs/redminote7pro.md b/docs/specs/Redmi_Note_7_Pro.md similarity index 100% rename from docs/specs/redminote7pro.md rename to docs/specs/Redmi_Note_7_Pro.md diff --git a/docs/specs/redmis2.md b/docs/specs/Redmi_S2.md similarity index 100% rename from docs/specs/redmis2.md rename to docs/specs/Redmi_S2.md