aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md91
1 files changed, 91 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..533d855
--- /dev/null
+++ b/README.md
@@ -0,0 +1,91 @@
+# DriedLamu
+```
+ ____ _ _ _
+| _ \ _ __(_) ___ __| | | __ _ _ __ ___ _ _
+| | | | '__| |/ _ \/ _` | | / _` | '_ ` _ \| | | |
+| |_| | | | | __/ (_| | |__| (_| | | | | | | |_| |
+|____/|_| |_|\___|\__,_|_____\__,_|_| |_| |_|\__,_|
+
+DriedLamu Firmware
+https://kasesag.me/projects/driedlamu
+https://git.firestarter.house/driedlamu.git
+```
+
+Custom Android 15 based firmware cleaned from bloatware and Google Play services for lamu (Moto G05, G15) based on the stock firmware.
+
+This project is a fork of DebloatedMotoWeed for penagarf (Moto G13/23).
+Original source: https://github.com/moto-penangf/DebloatedMotoWeed
+
+## Features
+
+**Core features** are referring to basic script functionality.
+**Optional features** refer to features which can be enabled or disabled using setup wizard before building the firmware.
+
+### Core features
+- Removed Motorola bloatware software (even the one which could not be removed manually)
+- Removed pre-installation of bloatware from sources such as Google, Motorola
+- Removed Google Play services
+- Removed all Motorola telemetry
+- Enabled Camera2 API
+- Replaced Moto Launcher with Lawnchair. Quickswitch (app switcher) integration enabled
+- Disabled Moto's HelloUI translucency
+- Changed default assistant from Google Assistant with a custom one. Invokes custom assistant allowing to quickly kill Android's SetupWizard, change behaviour of power button and default assistant application
+- Disabled 'Ram boost' feature by default
+
+### Optional features
+- Pre-installation of microG and F-Droid.
+- Installation of essential apps from Fossify package:
+ - Calculator
+ - Clock
+ - Contacts
+ - File Manager
+ - Gallery
+ - Messages
+ - Phone
+ - Voice Recorder
+ - Music Player
+ - Calendar
+- Added tones from LineageOS and replaced 'Hello Moto' default ringtone with retro version (OPTIONAL).
+- Installation of Root using APatch
+- Enabled insecure ADB
+- Disabled Moto's HelloUI systemwide
+ - Experimental feature. May cause small UI defects while making system UI look more like AOSP.
+
+### Current issues
+- Setting up a device can only be finished by hitting 'Set up offline' when wifi connection dialog appears. This will not be ever solved.
+- Default phone app has to be set manually by the user after the first boot-up. Might also not be solved.
+- Patched microG cannot be easily upgraded in non-rooted environment.
+
+#### To be done
+- Port FEC util from Android built system to CMake
+- Produce archive with modified firmware. Automatic script should handle that.
+
+#### To be done In very future!
+- bash: Better error checking
+- fec: build binary from source. Do not provide it in 'utils/bin' as there are different architectures
+- apks: cache apk downloaded metadata in order to not get rate limited
+
+## Installing
+
+### Requirements
+- Your device has to have an unlocked bootloader
+ - Make sure that you have installed kaeru as well and 'bldr_spoof' is disabled.
+- For building, Linux-based environment is required (x86_64, aarch64). You also might have to install Android Studio with CLI utilities.
+ - For now you cannot generate vbmeta images on Linux aarch64. Only x86_64 is fully supported.
+
+### Building
+- You have to have Android SDK installed to use Android specific utils.
+- Install dependecies
+ ```shell
+ sudo pacman -S android-tools apksigcopier dialog
+ ```
+- Run ```make config``` script to create configuration. You have to do this before proceeding forward.
+- Run ```make build``` script to build DriedLamu.
+- Run ```make flash``` script to flash DriedLamu on your device.
+- Run ```make upgrade``` script to upgrade DriedLamu on your device (might not always work).
+
+
+### Credits
+- https://www.rigacci.org/wiki/doku.php/doc/appunti/hardware/blackview_bv5300_pro
+- https://github.com/WeiguangTWK/fec-standalone-for-AVBTool
+- https://github.com/moto-penangf/DebloatedMotoWeed/