Add features to readme. (#41)

<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->
* Add notable features.
* Add check for latest SC64 firmware.

## Motivation and Context
<!--- What does this sample do? What problem does it solve? -->
<!--- If it fixes/closes/resolves an open issue, please link to the
issue here -->

## How Has This Been Tested?
<!-- (if applicable) -->
<!--- Please describe in detail how you tested your sample/changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots
<!-- (if appropriate): -->

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Improvement (non-breaking change that adds a new feature)
- [ ] Bug fix (fixes an issue)
- [ ] Breaking change (breaking change)
- [ ] Config and build (change in the configuration and build system,
has no impact on code or features)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

<!--- It would be nice if you could sign off your contribution by
replacing the name with your GitHub user name and GitHub email contact.
-->
Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL>
This commit is contained in:
Robin Jones 2023-08-18 00:20:53 +01:00 committed by GitHub
parent 33a1729792
commit bd7e33ed71
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,5 +1,5 @@
# N64 Flashcart Menu # N64 Flashcart Menu
**This repo and its documentation is currently experimental and subject to change without notice.** An open source menu for N64 flashcarts.
## Aims ## Aims
* Support as many N64 FlashCarts as possible. * Support as many N64 FlashCarts as possible.
@ -9,13 +9,26 @@
* Support as many common mods and features as possible. * Support as many common mods and features as possible.
## Current (notable) menu features
* Fully Open Source.
* Loads all known N64 games (including iQue and byteswapped ROMs).
* Emulator support (GB, GBC, NES) ROMs.
* N64 ROM box image support.
* Background image (PNG) support.
* Comprehensive ROM save database (including HomeBrew headers).
* Comprehensive ROM information display.
* Real Time Clock support.
* Music playback (MP3).
## Getting started ## Getting started
### SC64 ### SC64
Ensure the cart is running the latest [firmware](https://github.com/Polprzewodnikowy/SummerCart64/releases/latest)
Download the `sc64menu.n64` ROM from the latest action run assets. Download the `sc64menu.n64` ROM from the latest action run assets.
Add it to the root folder on your SD card. Add it to the root folder on your SD card.
### ED64 ### 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).