From c68be66236f1400c0d10b8436b56606d7ba3f0b6 Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Sun, 4 Aug 2024 19:50:12 +0100 Subject: [PATCH] Improve docs (#131) ## Description Improve documentation. ## Motivation and Context ## How Has This Been Tested? ## Screenshots ## 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. - [ ] 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. Signed-off-by: GITHUB_USER ## 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. --- README.md | 4 ++-- docs/00_getting_started_sd.md | 2 +- docs/99_developer_guide.md | 26 ++++++++++++++++---------- 3 files changed, 19 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 52d5ea2c..e094aeed 100644 --- a/README.md +++ b/README.md @@ -65,12 +65,12 @@ If required, you can manually adjust the file on the SD card using your computer ### SC64 * 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 * 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 diff --git a/docs/00_getting_started_sd.md b/docs/00_getting_started_sd.md index 1231a03c..4ee6e763 100644 --- a/docs/00_getting_started_sd.md +++ b/docs/00_getting_started_sd.md @@ -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*). -- 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`. - Place your ROMs on the SD Card, in any folder (**except for `menu`**). diff --git a/docs/99_developer_guide.md b/docs/99_developer_guide.md index 9e00fc43..ff6ad67c 100644 --- a/docs/99_developer_guide.md +++ b/docs/99_developer_guide.md @@ -2,6 +2,9 @@ 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: #### 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`. #### 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. * 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! 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/) + +### 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 +```