doc update

This commit is contained in:
Luxferre
2026-10-19 11:03:01 +03:00
parent 2ba30f1405
commit a6e3fa184f
2 changed files with 100 additions and 101 deletions
+12 -13
View File
@@ -2,8 +2,7 @@
![Bananarchy Banner](artwork/banner-800x240.png)
**Bananarchy** is a keypad-first Linux distribution hardforked from postmarketOS (`v26.06` / Alpine `edge` `armv7`), purpose-built for **Qualcomm MSM8905 (Snapdragon 205)** and **Qualcomm MSM8909 (Snapdragon
210)** smart feature phones with **240x320 QVGA non-touch displays** and **physical 12-key T9 keypads**.
**Bananarchy** is a keypad-first Linux distribution hardforked from postmarketOS (`v26.06` / Alpine `edge` `armv7`), purpose-built for **Qualcomm MSM8905 (Snapdragon 205)** and **Qualcomm MSM8909 (Snapdragon 210)** smart feature phones with **240x320 QVGA non-touch displays** and **physical 12-key T9 keypads**.
See [The Bananarchy Manifesto](./MANIFESTO.md) for the rationale behind this entire project.
@@ -13,9 +12,9 @@ The current Bananarchy version is `v0.0.1`.
---
## Supported MSM8909 / MSM8905 Devices
## Supported MSM8909 / MSM8905 devices
| Device | Codename | SoC | CPU / RAM | Display & Panel Firmware | Device Tree (`.dtb`) |
| Device | Codename | SoC | CPU / RAM | Display & panel firmware | Device tree (`.dtb`) |
| :--- | :--- | :--- | :--- | :--- | :--- |
| **Nokia 8110 4G** | `nokia-argon` | Qualcomm MSM8905 (SD205) | 2x Cortex-A7 @ 1.1 GHz, 512 MB | 2.4" 240x320 SPI (`nokia,argon-gc9305-v2-panel.bin`) | `qcom-msm8905-nokia-argon.dtb` |
| **Nokia 2720 Flip** | `nokia-beatles` | Qualcomm MSM8905 (SD205) | 2x Cortex-A7 @ 1.1 GHz, 512 MB | 2.8" 240x320 SPI (`nokia,beatles-gc9305-panel.bin`) | `qcom-msm8905-nokia-beatles.dtb` |
@@ -25,7 +24,7 @@ The current Bananarchy version is `v0.0.1`.
---
## Repository Structure
## Repository structure
```text
bananarchy/
@@ -89,15 +88,15 @@ bananarchy/
---
## Build & Customization Workflow
## Build & customization workflow
### 1. Regenerate Artwork Assets
### 1. Regenerate artwork assets
Whenever `artwork/icon-large.png` is updated, regenerate all icons, `240x320` wallpapers, and boot splashes:
```bash
./scripts/generate-artwork.py
```
### 2. Recompile Core Components (Optional — Prebuilts Included)
### 2. Recompile core components (optional — prebuilts included)
All components are pre-compiled in `prebuilt/` and `overlay/rootfs/`, and can be rebuilt from source at any time using rootless Docker (`alpine:3.24`):
```bash
# Rebuild multi-mode fcitx5-t9 input engine (src/fcitx5-t9 -> prebuilt/fcitx5-t9)
@@ -110,7 +109,7 @@ All components are pre-compiled in `prebuilt/` and `overlay/rootfs/`, and can be
./scripts/build-kernel-audio.sh
```
### 3. Customize Rootfs Packages or Configs
### 3. Customize rootfs packages or configs
```bash
./chroot-shell.sh
# Inside the container shell:
@@ -119,7 +118,7 @@ All components are pre-compiled in `prebuilt/` and `overlay/rootfs/`, and can be
# pkg-search <pattern>
```
### 4. Build Flashable Device Images
### 4. Build flashable device images
```bash
# Build for Nokia 8110 4G (default)
./rebuild-image.sh nokia-argon
@@ -130,9 +129,9 @@ All components are pre-compiled in `prebuilt/` and `overlay/rootfs/`, and can be
./rebuild-image.sh nokia-sparkler --mkinitfs
```
Output images are written to `images/`:
- `images/bananarchy-<device>.img` (Raw partitioned MBR image for EDL `userdata` or microSD card)
- `images/bananarchy-<device>.img` (raw partitioned MBR image for EDL `userdata` or microSD card)
- `images/bananarchy-<device>.sparse.img` (Android sparse image for `fastboot flash userdata`)
- `images/boot-bananarchy-<device>.img` (Kernel + initramfs + DTB boot image)
- `images/boot-bananarchy-<device>.img` (kernel + initramfs + DTB boot image)
---
@@ -141,7 +140,7 @@ Output images are written to `images/`:
```bash
sudo ./flash-edl.sh nokia-argon
```
See [MANUAL.md](MANUAL.md) for complete EDL, Fastboot, and microSD installation instructions, keypad navigation shortcuts, and the Multi-Mode T9 reference.
See [MANUAL.md](MANUAL.md) for complete EDL, Fastboot, and microSD installation instructions, keypad navigation shortcuts, and the multi-mode T9 reference.
## Credits