README: add supported devices and rearrange information

As this is the first thing people will see about our project, keep
it simple, but well arranged and informative.
This commit is contained in:
Ivaylo Ivanov authored and Ивайло Иванов committed 2025-11-03 17:19:38 +02:00
1 parent 467d16f378
commit 4d26881b3c
1 file changed
+71 -48
+71 -48
View File
@@ -1,62 +1,85 @@
# uniLoader
A secondary bootloader that is capable of loading the upstream Linux kernel for Android and iOS-based devices.</br></br>
The purpose behind it is to provide a small shim for avoiding vendor bootloader quirks.</br>
> (ex.: some newer Exynos phones leave decon framebuffer refreshing disabled right before jumping to kernel, which makes initial debugging efforts when bringing up the platform to upstream linux hard)</br>
The currently supported architectures are ARMV7 and AARCH64.</br>
## Preparation
1. Install a toolchain that matches your target architecture (ex. AArch64 cross-toolchain):
```sh
sudo apt install aarch64-linux-gnu
```
2. Clone the repository:
```sh
git clone https://github.com/ivoszbg/uniLoader
```
3. Navigate to the project directory:
```sh
cd uniLoader
```
4. Place your kernel, device tree and ramdisk blobs under the `blob/` directory.
**uniLoader** is a minimalistic loader, capable of booting Linux kernels.
It can be used as an intermediate bootloader, providing a clean booting
environment in case of a forced and buggy bootloader.
### Make Syntax
```sh
make ARCH=<arch> CROSS_COMPILE=<toolchain>
---
## Supported Architectures
- ARMv7
- ARMv8
---
## Supported Devices
### Apple
- N61AP
### Amazon
- PW3
### Google
- Taimen
### Nokia
- Essential
### Nothing
- Tetris
### QEMU
- Virt
### Samsung
- A105F
- A127F
- A3XELTE
- C1S
- HEROLTE
- G0S
- NOBLELTE
- JACKPOTLTE
- ZEROFLTE
- DREAMLTE
- STARLTE
- X1S
- J5LTE
- J4LTE
- GTA4XL
- R0Q
- R8S
### Volla
- Algiz
### Xiaomi
- Begonia
- Blossom
- Camellia
---
## Make Syntax
```bash
make ARCH=$(arch) CROSS_COMPILE=$(toolchain)
```
---
### Building Example
```sh
## Building Example
```bash
sudo apt install aarch64-linux-gnu
git clone https://github.com/ivoszbg/uniLoader
cd uniLoader
cp /home/user/linux/arch/arm64/boot/Image blob/Image
cp /home/user/linux/arch/arm64/boot/dts/exynos/exynos8895-dreamlte.dtb blob/dtb
cp /home/user/ramdisk.gz blob/ramdisk
make ARCH=aarch64 CROSS_COMPILE=aarch64-linux-gnu- -j4 dreamlte_defconfig
make ARCH=aarch64 CROSS_COMPILE=aarch64-linux-gnu- -j4
make ARCH=aarch64 CROSS_COMPILE=aarch64-linux-gnu- dreamlte_defconfig
make ARCH=aarch64 CROSS_COMPILE=aarch64-linux-gnu-
```
### Usage
---
```sh
For Apple devices: Load the generated uniLoader binary via PongoOS.
For Android devices: Replace the Linux kernel in your boot.img with the uniLoader binary.
```
### TODO LIST
1. [C] Allow loading instead of PongoOS for Apple devices;
2. [C] Fix/replace the libc implementation;
3. [M] Implement a serial library and make the debug lib less hacky;
4. [M] Implement more features:
> New devices</br>
> Boot menu with countdown timer and selectable items via GPIO volume keys</br>
> Threaded execution
<h6>
[C] = Critical for overall ease of use and functionality</br>
[M] = Nice to have :)
</h6>
### License
This project is licensed under GPL2.
## License
This project is licensed under GPLv2.