From 2f652d4d5ecc8c3d747e2319a1d87ea07063d12c Mon Sep 17 00:00:00 2001 From: TheRealKeto Date: Thu, 29 Jun 2023 01:17:00 -0400 Subject: [PATCH] Update README to include patch instructions Signed-off-by: TheRealKeto --- README.md | 11 ++++++++++- fix-rendering.patch | 4 ++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dd60cb7..c226c9b 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,11 @@ A pongoOS module for running the BRIX game, featuring rendering code I wrote at ## Compatibility Currently supported devices: + - iPhone 7 GSM (iPhone9,3) - iPad Pro 10.5-inch WiFi/Cellular (iPad7,4) - iPad 10.2-inch 7th Gen WiFi/Cellular (iPad7,12) -- iPod Touch 6th Gen (iPod7,1) +- iPod Touch 6th Gen (iPod7,1) ([requires extra patching](#48-inch-devices)) If your device is already supported, great! You won't have to modify the code. You can skip to [running BRIX](#running-brix). If your device isn't supported, adding support for your own device shouldn't be hard. @@ -58,6 +59,14 @@ Address: 0x20f1000a0 1. Run `make load_brix`. This will compile the module and load it in pongoOS. 2. Run `brix` in the pongoOS shell. Your device should now be running BRIX. +### 4.8-inch devices + +For devices with a 4.8-inch screen, a different method for rendering is required. Before building `brix`, make sure to apply the patch in `fix-rendering.patch`. + +``` +$ git apply -v fix-rendering.patch +``` + ## Controls - **Movement:** vol+, vol- diff --git a/fix-rendering.patch b/fix-rendering.patch index 12b04ef..8db741d 100644 --- a/fix-rendering.patch +++ b/fix-rendering.patch @@ -1,7 +1,7 @@ Fix rendering for the following devices: -* iPod Touch (all models) -* iPhone 5s (all models) +* iPod Touch (all supported models) +* iPhone 5s (iPhone6,2) * Any supported device with a 4.8 inch screen =================================================