Improved project description + How to use section

This commit is contained in:
w1nst0n 2020-06-07 15:03:49 +02:00
parent 63895282f5
commit 9fb83944c0

View file

@ -3,11 +3,11 @@
**DISCLAIMER**: Use this script at your own risk. I am not responsible for anything that could happen to your phone.
## Summary
I try to provide and maintain a universal tool which remove bloatwares on any (unrooted) Android phones.
I try to provide and maintain a universal tool which remove bloatwares on any (non-rooted) Android phones.
The main goal is to improve battery performance and privacy by limiting the tracking from preinstalled apps. The script has a menu that lets you choose what debloat list you want to use. I strongly encourage you to take a look at the lists because some apps are commented out by default. All packages are as well documented as possible in order to provide a better understanding of what you can delete or not.
The main goal is to improve battery performance and privacy by removing unnecessary and obscure system apps. This can also contribute to improve security by reducing [the attack surface](https://en.wikipedia.org/wiki/Attack_surface). The script has a menu that lets you choose what debloat list you want to use. I strongly encourage you to take a look at the lists because the default selection may not suit you. All packages are as well documented as possible in order to provide a better understanding of what you can delete or not.
This script *should* be safe with the default selection. The worse thing which could happen is preventing an essential system process to be loaded during boot causing then an unfortunate bootloop. After about 5 failed system boots, the phone will automatically reboot in recovery mode and you'll have to perform a FACTORY RESET.
This script *should* be safe with the default selection. The worse thing which could happen is preventing an essential system process to be loaded during boot causing then an unfortunate bootloop. After about 5 failed system boots, the phone will automatically reboot in recovery mode and you'll have to perform a FACTORY RESET. So make a backup !
In any case, you can NOT brick your device with this script ! That's the main thing, right ? :smiley:
@ -39,7 +39,7 @@ NB : It is NOT a real uninstallation for system apps (see the [FAQ](https://gitl
* [X] Motorola
* [X] Nokia
* [X] OnePlus
* [ ] Oppo
* [ ] Oppo
* [X] Samsung
* [X] Sony
* [ ] Wiko
@ -48,7 +48,7 @@ NB : It is NOT a real uninstallation for system apps (see the [FAQ](https://gitl
## Mobile carriers debloat lists
| **France** | **USA** |**Germany** |
|**France** | **USA** |**Germany** |
|:---------------:|:--------:|:----------:|
| Orange | T-Mobile | Telekom |
| SFR | Verizon | |
@ -57,40 +57,46 @@ NB : It is NOT a real uninstallation for system apps (see the [FAQ](https://gitl
## How to use it
- **Read the [FAQ](https://gitlab.com/W1nst0n/universal-android-debloater/-/wikis/FAQ) !!**
- **Read the [FAQ](https://gitlab.com/W1nst0n/universal-android-debloater/-/wikis/FAQ) !**
- **Do a proper backup of your data ! You can never be too careful !**
- Enable *Developer Options* on your smartphone.
- Turn on *USB Debugging*.
### LINUX
- Install *Android plateform tools* with your package manager :
Debian Base :
```console
apt-get install android-sdk-platform-tools
```
Arch-Linux Base :
```console
pacman -S android-tools
```
- Go to the release section, download the lastest release and enjoy :
```
- Turn on *USB Debugging* from the developper panel.
- Install *Android plateform tools* and *qpdf* on your PC.
- Download [the lastest release of the script](https://gitlab.com/W1nst0n/universal-android-debloater/-/releases)
- Check the debloat lists to be sure the default selection suits you.
- Run `debloat_script.sh` from a Unix terminal
```console
bash debloat_script.sh
```
### Installation of plateform tools and qpdf
#### LINUX
Debian Base :
```console
foo@bar:~$ sudo apt install android-sdk-platform-tools qpdf
```
Arch-Linux Base :
```console
foo@bar:~$ sudo pacman -S android-tools qpdf
```
Fedora :
```console
foo@bar:~$ sudo yum install android-tools qpdf
```
#### MAC OS
- Install [Homebrew](https://brew.sh/)
```console
foo@bar:~$ brew install android-platform-tools qpdf
```
### WINDOWS
- Install [WSL (Windows Subsystem for Linux)](https://itsfoss.com/install-bash-on-windows/) in order to be able to use bash scripts.
- Install [ADB](https://dl.google.com/android/repository/platform-tools-latest-windows.zip). If you want ADB support everywhere on your PC, you need to add the path of the ADB folder in the system variables (see [this](https://www.xda-developers.com/adb-fastboot-any-directory-windows-linux/)).
- Go to the release section and download the lastest release.
- Execute the script from the Ubuntu bash shell et voilà !
```
bash debloat_script.sh
- Install [WSL (Windows Subsystem for Linux)](https://itsfoss.com/install-bash-on-windows/) in order to be able to run bash scripts.
- Install *Android plateform tools* and *qpdf* :
```console
foo@bar:~$ sudo apt install android-sdk-platform-tools qpdf
```
- **Don't forget to check the debloat lists to see what are my default choices and to avoid any bad surprises.**