diff --git a/README.md b/README.md index 7ce67b5f..537bb9f9 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,32 @@ # LADB + A local ADB shell for Android! # How does it work? -LADB bundles an ADB server within the app libraries. Normally, this server cannot connect to the local device because it requires an active USB connection. However, Android's Wireless ADB Debugging feature allows the server and the client to speak to each other locally. - -# Initial Setup: -1. About -> Build Number -> Click 7 times -2. Developer Settings -> Wireless ADB Debugging -> On -3. Developer Settings -> ADB Debugging -> On - -# Troubleshooting: -If you encounter "device unauthorized" or "multiple devices connected", try this: -1. Enable Airplane Mode -2. Disconnect any USB devices -3. Kill and restart LADB - -Still not working? Try this: -1. Close LADB completely -2. Developer Settings -> Wireless ADB Debugging -> Off -3. Developer Settings -> ADB Debugging -> Off -4. Developer Settings -> Revoke authorizations -5. Reboot -6. Developer Settings -> Wireless ADB Debugging -> On -7. Developer Settings -> ADB Debugging -> On -8. Enable Airplane Mode -9. Open LADB - -# Credit -Thanks to Surge1223 for compiling ADB for the ARM/ARM64 architecture. + +LADB bundles an ADB server within the app libraries. Normally, this server cannot connect to the local device because it +requires an active USB connection. However, Android's Wireless ADB Debugging feature allows the server and the client to +speak to each other locally. + +# Initial Setup + +Use split-screen more or a pop-out window with LADB and Settings at the same time. This is because Android will +invalidate the pairing information if the dialog gets dismissed. Add a Wireless Debugging connection, and copy the +pairing code and port into LADB. Keep both windows open until the Settings dialog dismisses itself. + +# Issues + +LADB is sadly incompatible with Shizuku at the current moment. That means that if you have Shiuzuku installed, LADB will +usually fail to connect properly. You must uninstall it and reboot to use LADB. + +# Troubleshooting + +Most errors can be fixed by clearing the app data for LADB, removing all Wireless Debugging connections from Settings, +and rebooting. # License -While this project is GPLv3 licensed, I would like to add an additional parameter: please do not publish unofficial (user) LADB builds to the Google Play Store. -Still confused? Email me at tylernij@gmail.com. +While this project is GPLv3 licensed, I would like to add a parameter: please do not publish unofficial (user) LADB +builds to the Google Play Store. + +Still confused? Email me at tylernij+LADB@gmail.com.