The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2025-02-23 05:07:18 +01:00
Code Issues Packages Projects Releases Wiki Activity
N64FlashcartMenu/docs/00_index.md

37 lines
1.2 KiB
Markdown
Raw Normal View History

[develop] Documentation manual (#198) <!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> Reworks and splits the documentation. ## 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 --> Improves documentation to be more readable. ## 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) - [x] 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. <!--- 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 Based on the comprehensive summary, here are the release notes: - **New Features** - Added ROM history and favorites functionality - Introduced tabbed interface for file browsing - Implemented ROM information descriptions - Added support for ROM configuration overrides - Enhanced menu settings management - **Documentation** - Expanded user guide and documentation - Added sections on ROM patches, controller PAKs, and emulator support - Improved flashcart and menu customization instructions - **Chores** - Updated documentation structure - Refined code organization and naming conventions - Updated subproject references <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-01-12 23:15:27 +00:00
[..](README.md)
## User Guide
### General
- [Getting started](./10_getting_started_sd.md)
- [Menu controls](./11_menu_controls.md)
- [ROM configuration](./12_rom_configuration.md)
- [Datel Cheats](./13_datel_cheats.md)
- [ROM patches](./14_rom_patches.md)
- [Controller PAKs](./15_controller_paks.md)
- [Background Images](./16_background_images.md)
- [64DD](./17_64dd.md)
- [Emulators](./18_emulators.md)
- [Boxart](./19_gamepak_boxart.md)
- [Autoload N64 ROMs](./22_autoload_roms.md)
### Menus
- [File Browser](./31_file_browser.md)
- [Menu Settings](./32_menu_settings.md)
- [RTC Settings](./33_rtc_settings.md)
- [Menu Information](./35_menu_information.md)
- [Flashcart Information](./36_flashcart_information.md)
- [N64 Information](./37_n64_information.md)
### Other
- [MP3 player](./41_mp3_player.md)
- [Advanced customization](./61_advanced_customization.md)
- [Hardware mods](./62_hardware_mods.md)
Improve feature request template adds FAQ
2025-01-13 01:06:28 +00:00
- [FAQ](./81_faq.md)
[develop] Documentation manual (#198) <!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> Reworks and splits the documentation. ## 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 --> Improves documentation to be more readable. ## 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) - [x] 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. <!--- 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 Based on the comprehensive summary, here are the release notes: - **New Features** - Added ROM history and favorites functionality - Introduced tabbed interface for file browsing - Implemented ROM information descriptions - Added support for ROM configuration overrides - Enhanced menu settings management - **Documentation** - Expanded user guide and documentation - Added sections on ROM patches, controller PAKs, and emulator support - Improved flashcart and menu customization instructions - **Chores** - Updated documentation structure - Refined code organization and naming conventions - Updated subproject references <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-01-12 23:15:27 +00:00
#### Experimental Features
Subject to change
- [Experimental Features](./65_experimental.md)
### Developers
- [Developer guide](./99_developer_guide.md)
- [Contributing](https://github.com/Polprzewodnikowy/N64FlashcartMenu/blob/main/CONTRIBUTING.md)
Reference in New Issue Copy Permalink