Improve readme.

This commit is contained in:
Robin Jones 2023-10-10 20:52:19 +01:00 committed by GitHub
parent 1eb654d1c1
commit e9ee294327
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -12,7 +12,7 @@ An open source menu for N64 flashcarts.
## Current (notable) menu features ## Current (notable) menu features
* Fully Open Source. * Fully Open Source.
* Loads all known N64 games (including iQue and Aleck64 ROMs (even if they are byteswapped)). * Loads all known N64 games (including iQue and Aleck64 ROMs (even if they are byteswapped)).
* Fully emulates the 64DD and loads 64dd disks (SummerCart64 only). * Fully emulates the 64DD and loads 64DD disks (SummerCart64 only).
* Emulator support (NES, SNES, GB, GBC) ROMs. * Emulator support (NES, SNES, GB, GBC) ROMs.
* N64 ROM box image support. * N64 ROM box image support.
* Background image (PNG) support. * Background image (PNG) support.
@ -34,13 +34,14 @@ Download the latest `sc64menu.n64` file from the releases page, then put it in t
#### 64DD disk support #### 64DD disk support
For the ability to load and run 64DD disk images, you need to add the folder `/menu/64ddipl` on the SD card. For the ability to load and run 64DD disk images, you need to add the folder `/menu/64ddipl` on the SD card.
Download and add the relevant ipl files and rename them before adding the folder: Download and add the relevant ipl files and rename them before adding them to the folder:
`NDDE0.n64` the US Prototype IPL can be downloaded from [here](https://64dd.org/dumps/64DD_IPL_US_MJR.n64) - `NDDE0.n64` the US Prototype IPL can be downloaded from [here](https://64dd.org/dumps/64DD_IPL_US_MJR.n64)
`NDXJ0.n64` the JPN Development IPL can be downloaded from [here](https://64dd.org/dumps/64DD_IPL_DEV_H4G.n64) - `NDXJ0.n64` the JPN Development IPL can be downloaded from [here](https://64dd.org/dumps/64DD_IPL_DEV_H4G.n64)
`NDDJ2.n64` the JPN Retail IPL can be downloaded from [here](https://64dd.org/dumps/N64DD_IPLROM_(J).zip) - `NDDJ2.n64` the JPN Retail IPL can be downloaded from [here](https://64dd.org/dumps/N64DD_IPLROM_(J).zip)
### ED64 & ED64P ### ED64 & ED64P
Currently not supported, but there is an aim to do so. Currently not supported, but there is an aim to do so.
The aim is to replace [Altra64](https://github.com/networkfusion/altra64) and [ED64-UnofficialOS](https://github.com/n64-tools/ED64-UnofficialOS-binaries). The aim is to replace [Altra64](https://github.com/networkfusion/altra64) and [ED64-UnofficialOS](https://github.com/n64-tools/ED64-UnofficialOS-binaries).
@ -90,7 +91,6 @@ Then in the dev container, use `make run` or `make run-debug`
* Run `./localdeploy.bat` from the terminal * Run `./localdeploy.bat` from the terminal
Toggle the N64 power switch to load the ROM. Toggle the N64 power switch to load the ROM.
`ms-vscode.makefile-tools` will help (installed automatically in dev container). `ms-vscode.makefile-tools` will help (installed automatically in dev container).
@ -100,6 +100,11 @@ The ROM can be found in the `output` directory.
NOTE: a "release" version of the SC64 menu is called `sc64menu.n64` and can be created for when you want to add it directly to the SDCard. This is generated by running `make all` or running `make sc64`. NOTE: a "release" version of the SC64 menu is called `sc64menu.n64` and can be created for when you want to add it directly to the SDCard. This is generated by running `make all` or running `make sc64`.
### Others
* Add the required file to the correct folder on your SD card.
# Update Libdragon submodule # Update Libdragon submodule
This repo currently uses the `unstable` branch as a submodule at a specific commit. This repo currently uses the `unstable` branch as a submodule at a specific commit.
To update to the latest version, use `git submodule update --remote ` from the terminal. To update to the latest version, use `git submodule update --remote ` from the terminal.