Archives
/
NanoDroid
mirror of https://gitlab.com/Nanolx/NanoDroid
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update documentation

Browse Source
merge-requests/23/head
Christopher Roy Bratusek 6 years ago
parent c94a3ad000
commit ac46182878
4 changed files with 79 additions and 80 deletions
Show Stats Download Patch File Download Diff File

26
README.md
Unescape Escape View File

@ -115,14 +115,12 @@ NanoDroid includes
* on-device framework-patcher for microG support (signature spoofing)
* on-pc framework-patcher for microG support (signature spoofing)
* GApps are auto-removed during installation
* in Magisk Mode using [> Pseudo Debloat](doc/PseudoDebloat.md)
* in System Mode they are moved to `/sdcard/nandroid_backups`
* the Uninstaller will restore them (or re-flash the ROM)
* using [> NanoDroid-Overlay](doc/NanoDroidOverlay.md)
* the Uninstaller will restore them in System Mode (or re-flash the ROM)
* see the [> GApps Removal List](doc/GAppsRemoval.md)
* location packages conflicting with unified Nlp will are auto-removed during installation
* in Magisk Mode using [> Pseudo Debloat](doc/PseudoDebloat.md)
* in System Mode they are moved to `/sdcard/nandroid_backups`
* the Uninstaller will restore them (or re-flash the ROM)
* using [> NanoDroid-Overlay](doc/NanoDroidOverlay.md)
* the Uninstaller will restore them (or re-flash the ROM)
* see the [> GApps Removal List](doc/GAppsRemoval.md)
* F-Droid and it's privileged extension
* modified Play Store to allow (in-)app-purchases with microG
@ -131,7 +129,7 @@ NanoDroid includes
* custom init scripts
* pseudo-debloat feature (Magisk-only)
* disables applications systemless-ly
* pre-configured [> default settings](doc/PseudoDebloat.md)
* pre-configured [> default settings](doc/NanoDroidOverlay.md)
* several Open Source applications
* include replacements for the pseudo-debloated applications
* full list of [> included applications](doc/Applications.md)
@ -231,12 +229,14 @@ This lists features unique to NanoDroid.
#### NanoDroid-Overlay
The `nanodroid-overlay` script handles the pseudo-debloat feature (Magisk-only)
The `nanodroid-overlay` script handles the debloat feature
* show the list of pseudo-debloated apps
* add or remove apps from the list of pseudo-debloated apps
* pseudo-debloat applications in Magisk Mode
* force-debloat applications in System Mode
* show the list of debloated apps
* show the lits of non-debloated apps
* add or remove apps from the list of debloated apps
* Full details on the Pseudo Debloat feature [> Details](doc/PseudoDebloat.md)
* Full details on the NanoDroid-Overlay Script [> Details](doc/NanoDroidOverlay.md)
#### NanoDroid-Prop
@ -377,11 +377,9 @@ NanoDroid includes microG as follows
* go to **Yalp Store** > Settings > Installation Method > `Using system permissions`
* Play Store is modified to allow (in-)app-purchases with microG
* GApps and several location services conflict with microG and unified Nlp. Thus they are removed during NanoDroid installation
* in Magisk Mode using [> Pseudo Debloat](doc/PseudoDebloat.md)
* in System Mode they are moved to `/sdcard/nandroid_backups`
* using [> NanoDroid-Overlay](doc/NanoDroidOverlay.md)
* see [> GAppsRemoval](doc/GAppsRemoval.md) for more details
### F-Droid and Applications
F-Droid [> Website](http://www.fdroid.org) is an app store for Open Source applications.

3
doc/GAppsRemoval.md
Unescape Escape View File

@ -2,8 +2,7 @@
GApps and several location services conflict with microG and unified Nlp. Thus they are removed during NanoDroid installation
* in Magisk Mode using [> Pseudo Debloat](PseudoDebloat.md)
* in System Mode they are moved to `/sdcard/nandroid_backups`
* using [> NanoDroid-Overlay](doc/NanoDroidOverlay.md)
the Uninstaller will restore them (or re-flash the ROM)

68
doc/NanoDroidOverlay.md
Unescape Escape View File

@ -2,9 +2,71 @@
## Purpose
The `nanodroid-overlay` Script, respectively it's shortcut `novl` is used by NanoDroid to handle the Pseudo Debloat Feature.
The `nanodroid-overlay` Script, respectively it's shortcut `novl` is used by NanoDroid to handle the
Full details on the Pseudo Debloat feature [> Details](doc/PseudoDebloat.md)
* Pseudo Debloat Feature (Magisk Mode)
* Foce Debloat Feature (System Mode)
### Pseudo Debloat Feature
Magisk allows for apps to be magically removed upon runtime, they don't get actually removed from `/system` but they are pseudo-removed during runtime.
### Force Debloat Feature
In System Mode apps can are moved to `/sdcard/nanodroid_backups/` or restored from there.
## Default Settings
The following applications are debloated by default
* Basic Dreams
* Calendar
* CM File Manager
* crDroid Filemanager and Music Player
* Eleven, Phonograph (Audio Player)
* E-Mail + Exchange2
* Browser, Gello, Slimperience, Via Browser, Jelly (Browser)
* PhotoTable
* Sound Recorder, Recorder
* messaging (SMS & MMS)
* Wallpaper, WallpaperPickerGoogle (Google Wallpaper application)
* Wallpaper Backup
* mGerrit
* FM Radio
* Gallery2
* OmniSwitch
* Screencast
* Snap, Snapdragon Camera (Camera)
* Resurrection Remix Statistics
* Sim Toolkit
### Alter the list of pseudo-debloated applications
You can pseudo-debloat applications by adding them to configuration file
`.nanodroid-overlay`
on your device, in one of the following directories
* `/sdcard` (internal storage)
* `/external_sd` (TWRP path to SD Card (if any))
* directory containing the zip file
* `/data` (fallabck)
See the [default settings](.nanodroid-overlay).
Alternatively you can also use the NanoDroid Setup Wizard package instead of manual creation of the configuration file.
The syntax is pretty simple:
* one app per line
* name must be an exact match
After you've made your changes, issue the following command on your device, either using `adb shell` or **Termux** as root:
`nanodroid-overlay --update`
This needs to be done in normal environment. If you're in **TWRP** you'll have to manually mount `/magisk` (you may use the `mount-magisk` script from the git repo for this purpose).
## Invocation
@ -40,6 +102,8 @@ create Overlays from config file
`-u`, `--update`
**The following features are only available in Magisk Mode:**
remove existing Overlays and re-create them from the config file
`-c`, `--clear`

62
doc/PseudoDebloat.md
Unescape Escape View File

@ -1,62 +0,0 @@
# Pseudo-Debloated applications
Magisk allows for apps to be magically removed upon runtime, they don't get actually removed from `/system` but they are pseudo-removed during runtime. The pseudo-debloat feature is not available when NanoDroid is installed in System Mode
## Default Settings
The following applications are pseudo-debloated by default
* Basic Dreams
* Calendar
* CM File Manager
* crDroid Filemanager and Music Player
* Eleven, Phonograph (Audio Player)
* E-Mail + Exchange2
* Browser, Gello, Slimperience, Via Browser, Jelly (Browser)
* PhotoTable
* Sound Recorder, Recorder
* messaging (SMS & MMS)
* Wallpaper, WallpaperPickerGoogle (Google Wallpaper application)
* Wallpaper Backup
* mGerrit
* FM Radio
* Gallery2
* OmniSwitch
* Screencast
* Snap, Snapdragon Camera (Camera)
* Resurrection Remix Statistics
* Sim Toolkit
## Alter the list of pseudo-debloated applications
**This feature is only available when installing as Magisk Module!**
You can pseudo-debloat applications by adding them to configuration file
`.nanodroid-overlay`
on your device, in one of the following directories
* `/sdcard` (internal storage)
* `/external_sd` (TWRP path to SD Card (if any))
* directory containing the zip file
* `/data` (fallabck)
See the [default settings](.nanodroid-overlay).
Alternatively you can also use the NanoDroid Setup Wizard package instead of manual creation of the configuration file.
The syntax is pretty simple:
* one app per line
* name must be an exact match
After you've made your changes, issue the following command on your device, either using `adb shell` or **Termux** as root:
`nanodroid-overlay --update`
This needs to be done in normal environment. If you're in **TWRP** you'll have to manually mount `/magisk` (you may use the `mount-magisk` script from the git repo for this purpose).
## Additional options
The `nanodroid-overlay` script has more options available, see [> nanodroid-overlay](NanoDroidOverlay).
Write Preview
Loading…
Cancel
Save