Skip to content

Commit

Permalink
Update README to include patch instructions
Browse files Browse the repository at this point in the history
Signed-off-by: TheRealKeto <[email protected]>
  • Loading branch information
TheRealKeto committed Jun 29, 2023
1 parent 26a9cf7 commit 2f652d4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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-
Expand Down
4 changes: 2 additions & 2 deletions fix-rendering.patch
Original file line number Diff line number Diff line change
@@ -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

=================================================
Expand Down

0 comments on commit 2f652d4

Please sign in to comment.