Skip to content

Commit 1fa6093

Browse files
committed
update readme
1 parent 90fa5a9 commit 1fa6093

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

+21-3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ This repo contains custom code as well as a patching utility to add additional f
2929
* See [the mario document for more information](docs/mario.md).
3030

3131
### Zelda (`PATCH_PARAMS="--device=zelda"`)
32-
Coming Soon! Currently not supported.
32+
* No extra features currently implemented, just compatible with retro-go
33+
* External flash savings to come in the future.
3334

3435
# Usage
3536
Place your `internal_flash_backup_${DEVICE}.bin` and `flash_backup_${DEVICE}.bin` in the root of this
@@ -64,19 +65,36 @@ I recommend pressing the power button at the same time you press enter. Note tha
6465
For additional configuration options, run `make help`.
6566

6667

67-
### Retro Go
68+
### Retro Go (Mario)
6869
Since most people are going to be using this with retro-go, want the minimum amount of external storage used, and don't care about the sleeping images or the mario song easter egg, here are the recommend commands. Note that this uses an undocumented 128KB of internal Bank 1 and requires a [patched version of openocd](https://github.com/kbeckmann/ubuntu-openocd-git-builder) installed.
6970

7071
```
7172
# in this repo
7273
make clean
73-
make PATCH_PARAMS="--internal-only" flash_patched_int
74+
make PATCH_PARAMS="--device=mario --internal-only" flash_patched_int
7475
7576
# in the retro-go repo
7677
make clean
7778
make -j8 INTFLASH_BANK=2 flash
7879
```
7980

81+
### Retro Go (Zelda)
82+
83+
This assumes you have upgraded the external flash to something larger than 4MB. Currently zelda CFW requires 4MB of external flash (to be reduced at some point in the future).
84+
85+
```
86+
# in this repo
87+
make clean
88+
make PATCH_PARAMS="--device=mario" flash_patched
89+
90+
# in the retro-go repo
91+
make clean
92+
# In this example, I'm assuming you have a 64MB flash chip (60 = 64 - 4)
93+
make -j8 EXTFLASH_SIZE_MB=60 EXTFLASH_OFFSET=4194304 INTFLASH_BANK=2 flash
94+
```
95+
96+
97+
8098
# Troubleshooting:
8199

82100
### Unable to install python dependency `keystone-engine` on rpi3

0 commit comments

Comments
 (0)