Skip to content

Commit 89f7857

Browse files
committed
docs: add compatibility guide
1 parent d65fa11 commit 89f7857

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

docs/COMPATIBILITY.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Compatibility Guide
2+
3+
This project targets OPPO, OnePlus, and realme devices using ColorOS, OxygenOS, or realme UI.
4+
5+
## Android versions
6+
7+
| Android version | Status | Notes |
8+
|---|---|---|
9+
| Android 15 | Supported target | Needs testing across each brand skin |
10+
| Android 16 | Supported target | Expect stronger storage and system restrictions |
11+
| Android 17 | Experimental target | Test before customer release |
12+
13+
## Brand support
14+
15+
| Brand | Expected behavior |
16+
|---|---|
17+
| OPPO | Best target for ColorOS theme testing |
18+
| realme | Similar path expectations, but realme UI changes by region |
19+
| OnePlus | OxygenOS/ColorOS base differs by device and region |
20+
21+
## Customer test checklist
22+
23+
Ask every tester to send:
24+
25+
- Device brand
26+
- Device model
27+
- Android version
28+
- ColorOS/OxygenOS/realme UI version
29+
- Root solution: Magisk, KernelSU, APatch, or none
30+
- Boot success after install
31+
- Theme folder detected or not
32+
- Screenshots of lock screen, home screen, wallpaper, and About phone
33+
34+
## Safe compatibility rule
35+
36+
Do not promise full theme support before testing on that exact model and firmware. OEM theme paths can change between updates, regions, and Android versions.

0 commit comments

Comments
 (0)