From 214fbabc4b4c22ed32b5d307cd6ae996d4488efb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20=22IlDucci?= Date: Wed, 22 Jan 2025 13:38:16 +0000 Subject: [PATCH] [develop] Additional proofread of the docs (#209) ## Description - Made sure the titles are identical between the index and each of the page's headers. - Removed "Joypad" as it's not a proper word used on N64's public-facing reference documents. - Added some of the writing included on the main branch. - Added code tags to some button names I missed out. - Other uppercasing fixes and nitpicks. ## Motivation and Context Typo fixing, leaving the docs polished to the Nth degree. ## Types of changes - [ ] 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: - [ ] My code follows the code style of this project. - [x] My change requires a change to the documentation. - [x] I have updated the documentation accordingly. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. --- docs/00_index.md | 4 ++-- docs/10_getting_started_sd.md | 3 ++- docs/11_menu_controls.md | 4 ++-- docs/12_rom_configuration.md | 5 ++--- docs/13_datel_cheats.md | 4 ++-- docs/16_background_images.md | 4 ++-- docs/19_gamepak_boxart.md | 2 +- docs/31_file_browser.md | 2 +- docs/33_rtc_settings.md | 2 +- docs/41_mp3_player.md | 2 +- 10 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/00_index.md b/docs/00_index.md index 0124b502..668784c3 100644 --- a/docs/00_index.md +++ b/docs/00_index.md @@ -3,9 +3,9 @@ ### General - [Initial Setup of an SD Card](./10_getting_started_sd.md) -- [Basic Joypad Controls](./11_menu_controls.md) +- [Basic Controls](./11_menu_controls.md) - [ROM Configuration](./12_rom_configuration.md) -- [Cheats (Gameshark etc.)](./13_datel_cheats.md) +- [Cheats (Gameshark, etc.)](./13_datel_cheats.md) - [ROM Patches (Hacks, Fan Translations, etc.)](./14_rom_patches.md) - [Controller PAKs](./15_controller_paks.md) - [Background Images](./16_background_images.md) diff --git a/docs/10_getting_started_sd.md b/docs/10_getting_started_sd.md index 6981d56e..33a68838 100644 --- a/docs/10_getting_started_sd.md +++ b/docs/10_getting_started_sd.md @@ -1,5 +1,5 @@ [Return to the index](./00_index.md) -## Initial Setup of the SD Card +## Initial Setup of an SD Card ### First steps Connect the SD card to your PC and ensure it is properly formatted to be compatible with your flashcart. @@ -14,6 +14,7 @@ Connect the SD card to your PC and ensure it is properly formatted to be compati - An SD formatted with 128 kiB cluster size is recommended. - Download the latest `sc64menu.n64` file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card. - Place your ROM files on the SD card, **in any folder except `menu`**. +**NOTE:** byteswapped ROM's will increase load times. #### Preparations for other supported flashcarts - FAT32 recommended. diff --git a/docs/11_menu_controls.md b/docs/11_menu_controls.md index 650a7826..71a0ba22 100644 --- a/docs/11_menu_controls.md +++ b/docs/11_menu_controls.md @@ -1,5 +1,5 @@ [Return to the index](./00_index.md) -## Menu Controls +## Basic Controls #### Fast scroll @@ -7,7 +7,7 @@ Press either the `C-Up` or `C-Down` buttons to scroll by pages, rather than by e #### N64FlashcartMenu settings Press the `START` button on the browser screen to open the Settings window. -![Browser context menu](./images/main-context-menu.png "Browser context menu") +![Main context menu](./images/main-context-menu.png "Main context menu") From here you can edit some of the N64FlashcartMenu settings, see information about either the console, the flashcart you are using or N64FlashcartMenu itself, and if your cart has Real-Time Clock (RTC) support, you can also change its date and time. #### Browser options diff --git a/docs/12_rom_configuration.md b/docs/12_rom_configuration.md index 85cb17e7..a0a049bb 100644 --- a/docs/12_rom_configuration.md +++ b/docs/12_rom_configuration.md @@ -5,10 +5,9 @@ The N64FlashcartMenu allows overriding the ROM's default configuration that is p The internal database is contained within `rom_info.c`. -The N64FlashcartMenu expects that you are using a flashcart that has an [ultra cic](https://n64brew.dev/wiki/Checking_Integrated_Circuit) available. - -NOTE: Some old ROM hacks may have adjusted the ROM code to manipllate the expected CIC and save type in order to allow compatibility with more available chips (usually 6102) as was used on flashacarts prior to 2018. If it does, you may need to override the internal database using the override settings. +The N64FlashcartMenu expects that you are using a flashcart that has an [UltraCIC](https://n64brew.dev/wiki/Checking_Integrated_Circuit) available. +NOTE: Some old ROM hacks may have adjusted the ROM code to manipulate the expected CIC and save type in order to allow compatibility with more available chips (usually 6102) as was used on flashcarts prior to 2018. If it does, you may need to override the internal database using the override settings. If you override the defaults and want to go back to the default ones, delete the `.ini` file. diff --git a/docs/13_datel_cheats.md b/docs/13_datel_cheats.md index 2c8dac3a..08ac1612 100644 --- a/docs/13_datel_cheats.md +++ b/docs/13_datel_cheats.md @@ -1,5 +1,5 @@ [Return to the index](./00_index.md) -## Datel/InterAct Cheats +## Cheats (Gameshark, etc.) The N64FlashcartMenu supports the cheat code types made popular by the peripherals: - GameShark @@ -10,7 +10,7 @@ Another product by Blaze, called the Xploder64/Xplorer64 also existed in some re **WARNING**: It is not advised to connect a physical cheat cartridge in conjunction with most flashcarts. -The N64FlashcartMenu can only support cheat codes based on datel carts when also using an Expansion pak. +The N64FlashcartMenu can only support cheat codes based on Datel carts when also using an Expansion Pak. Caveats: - Something about cheats and expansion paks. diff --git a/docs/16_background_images.md b/docs/16_background_images.md index 1dc7f333..0ad51734 100644 --- a/docs/16_background_images.md +++ b/docs/16_background_images.md @@ -2,6 +2,6 @@ ## Background Images ### How to add a background image -First copy an image in .PNG format to anywhere on the SD card. Then when the N64FlashcartMenu is loaded on the N64, browse to the image and then select it to show it on the screen. Press the A Button again to open up the confirmation message, which will ask if you want to set a new background image. +First copy an image in .PNG format to anywhere on the SD card. Then when the N64FlashcartMenu is loaded on the N64, browse to the image and then select it to show it on the screen. Press the `A` Button again to open up the confirmation message, which will ask if you want to set a new background image. -Press the A Button to confirm and set the image as your new background or press the B Button to cancel and return to the image display screen. +Press the `A` Button to confirm and set the image as your new background or press the `B` Button to cancel and return to the image display screen. diff --git a/docs/19_gamepak_boxart.md b/docs/19_gamepak_boxart.md index de032db2..bf73681a 100644 --- a/docs/19_gamepak_boxart.md +++ b/docs/19_gamepak_boxart.md @@ -1,5 +1,5 @@ [Return to the index](./00_index.md) -## Game Box Art Images +## Game Art Images To use N64 game box art images, place your PNG files within the `sd:/menu/boxart/` folder. #### Supported images diff --git a/docs/31_file_browser.md b/docs/31_file_browser.md index ada744ce..04ddc9f1 100644 --- a/docs/31_file_browser.md +++ b/docs/31_file_browser.md @@ -13,7 +13,7 @@ The File Browser allows you to navigate and manage files on your N64 flashcart. ### Usage Instructions 1. **Navigating Files**: - - Use the directional Up and Down buttons (C-Up and C-Down for fast scrolling) to move through the list of files and directories. + - Use the directional `Up` and `Down` buttons (`C-Up` and `C-Down` for fast scrolling) to move through the list of files and directories. - Press the `A` Button to open a directory or load a supported file. 2. **Performing File Operations**: diff --git a/docs/33_rtc_settings.md b/docs/33_rtc_settings.md index e2e87893..f40165b5 100644 --- a/docs/33_rtc_settings.md +++ b/docs/33_rtc_settings.md @@ -1,5 +1,5 @@ [Return to the index](./00_index.md) -## Real-Time Clock Settings +## Date-Time (RTC) Settings ![RTC information](./images/rtc-information.png "RTC Information") If your flashcart supports the Real-Time Clock (RTC from herein) feature, N64FlashcartMenu has the ability to read and set it. diff --git a/docs/41_mp3_player.md b/docs/41_mp3_player.md index 9b9a2597..b1baa43a 100644 --- a/docs/41_mp3_player.md +++ b/docs/41_mp3_player.md @@ -1,6 +1,6 @@ [Return to the index](./00_index.md) ## MP3 Player - + The N64FlashcartMenu includes an MP3 Player that can read MP3 files from the SD Card. At the time of writing, MP3 files must have a sample rate of 44100 Hz or higher. Whilst in the menu, select an MP3 file in the File Browser to go to the MP3 Player screen, where the audio playback will begin immediately.