mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2024-11-21 18:19:19 +01:00
Improve docs (#131)
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> Improve 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 --> ## 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 - **Documentation** - Updated URLs in the README for direct access to firmware downloads for SC64 and 64drive. - Enhanced hyperlink for the releases page in the Getting Started guide for better user accessibility. - Added a new section with a quickstart video tutorial in the Developer Guide to assist new developers. - Improved clarity and formatting in the Developer Guide for installation prerequisites and webpage serving instructions. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
parent
f10097de70
commit
c68be66236
@ -65,12 +65,12 @@ If required, you can manually adjust the file on the SD card using your computer
|
|||||||
|
|
||||||
### SC64
|
### SC64
|
||||||
* Ensure the cart has the latest [firmware](https://github.com/Polprzewodnikowy/SummerCart64/releases/latest) installed.
|
* Ensure the cart has the latest [firmware](https://github.com/Polprzewodnikowy/SummerCart64/releases/latest) installed.
|
||||||
* Download the latest `sc64menu.n64` file from the releases page, then put it in the root directory of your SD card.
|
* 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.
|
||||||
|
|
||||||
|
|
||||||
### 64drive
|
### 64drive
|
||||||
* Ensure the cart has the latest [firmware](https://64drive.retroactive.be/support.php) installed.
|
* Ensure the cart has the latest [firmware](https://64drive.retroactive.be/support.php) installed.
|
||||||
* Download the latest `menu.bin` file from the releases page, then put it in the root directory of your SD card.
|
* Download the latest `menu.bin` file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card.
|
||||||
|
|
||||||
|
|
||||||
### ED64 & ED64P
|
### ED64 & ED64P
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Using your PC, insert the SD card and ensure it is formatted for compatibility with your flashcart (*FAT32 and EXFAT are fully supported on the SC64*).
|
Using your PC, insert the SD card and ensure it is formatted for compatibility with your flashcart (*FAT32 and EXFAT are fully supported on the SC64*).
|
||||||
|
|
||||||
- Download the latest `sc64menu.n64` (assuming you are using an *sc64*) file from the releases page, then put it in the root directory of your SD card.
|
- Download the latest `sc64menu.n64` (assuming you are using an *sc64*) file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card.
|
||||||
- Create a folder in the root of your SD card called `menu`.
|
- Create a folder in the root of your SD card called `menu`.
|
||||||
- Place your ROMs on the SD Card, in any folder (**except for `menu`**).
|
- Place your ROMs on the SD Card, in any folder (**except for `menu`**).
|
||||||
|
|
||||||
|
@ -2,6 +2,9 @@
|
|||||||
|
|
||||||
You can use a dev container in VSCode to ease development.
|
You can use a dev container in VSCode to ease development.
|
||||||
|
|
||||||
|
### A quickstart video tutorial on how to set up your environment
|
||||||
|
[![Devcontainer quickstart guide](http://img.youtube.com/vi/h05ufOsRgZU/0.jpg)](http://www.youtube.com/watch?v=h05ufOsRgZU "Devcontainer quickstart guide").
|
||||||
|
|
||||||
|
|
||||||
### To deploy:
|
### To deploy:
|
||||||
#### SC64
|
#### SC64
|
||||||
@ -33,7 +36,7 @@ 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`.
|
||||||
|
|
||||||
#### Ares Emulator
|
#### Ares Emulator
|
||||||
For ease of development and debugging, the menu ROM can run in the Ares emulator (without most flashcart features).
|
For ease of development and debugging, the menu ROM can run in the [Ares emulator](https://ares-emu.net/) (without most flashcart features).
|
||||||
|
|
||||||
* Ensure you have the Ares emulator on your computer.
|
* Ensure you have the Ares emulator on your computer.
|
||||||
* Load the `N64FlashcartMenu.n64` ROM.
|
* Load the `N64FlashcartMenu.n64` ROM.
|
||||||
@ -51,13 +54,16 @@ Run `doxygen` from the dev container terminal.
|
|||||||
Make sure you fix the warnings before creating a PR!
|
Make sure you fix the warnings before creating a PR!
|
||||||
Generated documentation is located in the `output/docs` folder and auto-published to the `gh-pages` branch when merged with `main`.
|
Generated documentation is located in the `output/docs` folder and auto-published to the `gh-pages` branch when merged with `main`.
|
||||||
|
|
||||||
### Test generated docs in dev-container
|
|
||||||
Install Prerequisites:
|
|
||||||
`apt-get install ruby-full build-essential zlib1g-dev`
|
|
||||||
`gem install jekyll bundler`
|
|
||||||
You can then serve the webpage:
|
|
||||||
`cd output/docs`
|
|
||||||
`jekyll serve`
|
|
||||||
|
|
||||||
|
|
||||||
Once merged, they can be viewed [here](https://polprzewodnikowy.github.io/N64FlashcartMenu/)
|
Once merged, they can be viewed [here](https://polprzewodnikowy.github.io/N64FlashcartMenu/)
|
||||||
|
|
||||||
|
### Test generated docs in the dev-container
|
||||||
|
Install Prerequisites:
|
||||||
|
```bash
|
||||||
|
apt-get install ruby-full build-essential zlib1g-dev
|
||||||
|
gem install jekyll bundler
|
||||||
|
```
|
||||||
|
|
||||||
|
You can then serve the webpage:
|
||||||
|
```bash
|
||||||
|
cd output/docs && jekyll serve
|
||||||
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user