website: fix adb-permissions.md

keymapperorg · Nov 24, 2021 · 293bc7f · 293bc7f
1 parent 426ad72
commit 293bc7f
Showing 1 changed file with 53 additions and 44 deletions.
diff --git a/docs/user-guide/adb-permissions.md b/docs/user-guide/adb-permissions.md
@@ -1,66 +1,78 @@
-## Prepare ADB (Android Debug Bridge)
+## WRITE_SECURE_SETTINGS
 
-!!! tip You might need to attempt this process multiple times because it can be flaky.
+There are 3 ways to grant this permission.
 
-1. Enable developer options on your device by going to device Settings -> 'About Phone' and tapping 'Build Number' many times until it says you've enabled developer options. The location of the Build Number may vary between devices.
+- Use Shizuku (Key Mapper 2.4.0+ only). This is recommended on all devices running Android 11 and newer. This requires some setting up. Read the guide [here](shizuku.md).
 
-    ??? info "Screenshot"
-        ![](../images/android-about-phone.png)
+- If your device is **rooted**, Key Mapper can grant itself these permissions by enabling the "Key Mapper has root permission" toggle in the Key Mapper settings.
 
-2. Enable USB Debugging in developer options and plug your device into your PC.
+- If your device is **not rooted** and you don't want to use Shizuku you must do the following...
 
-    ??? info "Screenshot"
-        ![](../images/android-developer-options-usb-debugging.png)
+    1. Follow the "Prepare ADB" guide at the bottom of this page.
+
+    2. Type or paste in a terminal:
+
+    ```
+    adb shell pm grant io.github.sds100.keymapper android.permission.WRITE_SECURE_SETTINGS
+    ```
+
+    !!! attention
+        For CI builds (the app icon with a green square) the package name is `io.github.sds100.keymapper.ci`.
+        For Debug builds (the app icon with a yellow square) the package name is `io.github.sds100.keymapper.debug`.
 
-3. Download the [Android SDK platform tools](https://developer.android.com/studio/releases/platform-tools.html) from here and unzip it.
+    These permissions persist across reboots but need to be granted again if the app is reinstalled.
 
-4. Open a terminal/command prompt in the unzipped folder.
+## Enabling the Accessibility Service
 
 5. Type or paste in a terminal: `adb devices` and your device then click the prompt on your phone to allow USB debugging from your PC.
 
-   ??? info "Prompt on phone"
+    ??? info "Prompt on phone"
         ![](../images/android-allow-usb-debugging-dialog.png)
 
-6. Type `adb devices` again and make sure you see the correct output as shown below.
-
-   ??? success "Correct command prompt output"
-   ![](../images/command-prompt-adb-devices-success.png)
-
-   ??? failure "Incorrect command prompt outputs"
-   ![](../images/command-prompt-adb-devices-no-devices.png)
-   ![](../images/command-prompt-adb-devices-offline.png)
-   ![](../images/command-prompt-adb-devices-unauthorized.png)
-
-## WRITE_SECURE_SETTINGS
+2. To add Key Mapper to the List of the enabled accessibility providers, type or paste in a terminal:
 
-There are 3 ways to grant this permission.
+    ??? success "Correct command prompt output"
+        ![](../images/command-prompt-adb-devices-success.png)
+
+    ??? failure "Incorrect command prompt outputs"
+        ![](../images/command-prompt-adb-devices-no-devices.png)
+        ![](../images/command-prompt-adb-devices-offline.png)
+        ![](../images/command-prompt-adb-devices-unauthorized.png)
 
-- Use Shizuku (Key Mapper 2.4.0+ only). This is recommended on all devices running Android 11 and
-  newer. This requires some setting up. Read the guide [here](shizuku.md).
+!!! tip You might need to attempt this process multiple times because it can be flaky.
 
-- If your device is **rooted**, Key Mapper can grant itself these permissions by enabling the "Key
-  Mapper has root permission" toggle in the Key Mapper settings.
+1. Enable developer options on your device by going to device Settings -> 'About Phone' and tapping 'Build Number' many times until it says you've enabled developer options. The location of the Build Number may vary between devices.
 
-- If your device is **not rooted** and you don't want to use Shizuku you must do the following...
+    ??? info "Screenshot"
+        ![](../images/android-about-phone.png)
 
-    1. Follow the "Prepare ADB" guide at the top of this page.
+2. Enable USB Debugging in developer options and plug your device into your PC.
 
-    2. Type or paste in a terminal:
+    ??? info "Screenshot"
+        ![](../images/android-developer-options-usb-debugging.png)
 
-    ```
-    adb shell pm grant io.github.sds100.keymapper android.permission.WRITE_SECURE_SETTINGS
-    ```
+3. Download the [Android SDK platform tools](https://developer.android.com/studio/releases/platform-tools.html) from here and unzip it.
 
-  !!! attention For CI builds (the app icon with a green square) the package name
-  is `io.github.sds100.keymapper.ci`. For Debug builds (the app icon with a yellow square) the
-  package name is `io.github.sds100.keymapper.debug`.
+4. Open a terminal/command prompt in the unzipped folder.
 
-  These permissions persist across reboots but need to be granted again if the app is reinstalled.
+5. Type or paste in a terminal: `adb devices` and your device then click the prompt on your phone to allow USB debugging from your PC.
 
-## Enabling the Accessibility Service
+    !!! attention
+        For CI builds (the app icon with a green square) the package name is `io.github.sds100.keymapper.ci`. For Debug builds (the app icon with a yellow square) the package name is `io.github.sds100.keymapper.debug`.
 
-You may wish to enable Key Mapper's accessibility service using ADB if you cannot do so in-app due
-to manufacturer constraints.
+6. Type `adb devices` again and make sure you see the correct output as shown below.
+
+    ??? success "Correct command prompt output"
+        ![](../images/command-prompt-adb-devices-success.png)
+
+    ??? failure "Incorrect command prompt outputs"
+        ![](../images/command-prompt-adb-devices-no-devices.png)
+        ![](../images/command-prompt-adb-devices-offline.png)
+        ![](../images/command-prompt-adb-devices-unauthorized.png)
+
+!!! tip
+    It is recommended to also follow the instructions to grant the WRITE_SECURE_SETTINGS permission
+    on this page so Key Mapper can start and stop the accessibility service itself.
 
 1. Follow the "Prepare ADB" guide at the top of this page.
 
@@ -69,7 +81,4 @@ to manufacturer constraints.
 
     ```
     adb shell settings put secure enabled_accessibility_services io.github.sds100.keymapper/io.github.sds100.keymapper.service.MyAccessibilityService
-    ```
-
-3. It is recommended to also follow the instructions to grant the WRITE_SECURE_SETTINGS permission
-   on this page so Key Mapper can start and stop the accessibility service itself.
+    ```