mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-12-18 19:15:58 +01:00
<!--- Provide a general summary of your changes in the Title above -->
## Description
<!--- Describe your changes in detail -->
Improves documentation.
Moves to docfx for website publishing.
Splits devcontainers.
## 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 -->
Vastly improves documentation published to website.
## 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)
- [ ] Documentation Improvement
- [ ] 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.
You agree with the license terms and that other license types may be
granted with permission of the original `N64FlashcartMenu` project
license holders.
<!--- 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 is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Major restructuring and expansion of the user guide and table of
contents; many new and revised pages, formatting improvements, guidance
additions, and API/site doc generation configuration.
* **Chores**
* Added multiple containerized development environments and supporting
build scripts; CI workflow added to build and publish the documentation
site.
* **Style**
* Minor wording and title tweaks across docs; updated ignore rules and
documentation output paths.
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1.5 KiB
1.5 KiB
Preparations for OTHER supported flashcarts
- It is recommended to format the SD Card to FAT32 with the default cluster size.
- Download the latest menu file specific for your flashcart and place it in the expected location.
- Remove the Micro SD Card from your computer and insert it into the flashcart.
EverDrive-64 - WIP - UNTESTED AND UNSUPPORTED - USE AT OWN RISK
Currently not supported, but work is in progress (See PRs).
Caution
The menu may be able to load ROMs but cannot guarantee save functionality. Existing saves may be corrupted.
EverDrive-64 (V series)
The aim is to reach feature parity with ED64-UnofficialOS / ED64-OfficialOS.
- Download the
OS64.v64ROM from the latest [action run - assets] and place it in the/ED64folder.
EverDrive-64 (X series)
The aim is to reach feature parity with OS for now.
- Download the
OS64.v64ROM from the latest [PR action run - assets] and place it in the/ED64folder.
ED64P (clones)
The aim is to reach feature parity with Altra64
- Download the
OS64P.v64ROM from the latest [PR action run - assets] and place it in the/ED64Pfolder.