mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2024-11-22 02:29:19 +01:00
c68be66236
<!--- 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 -->
70 lines
2.8 KiB
Markdown
70 lines
2.8 KiB
Markdown
## Developer documentation
|
|
|
|
You can use a dev container in VSCode to ease development.
|
|
|
|
### A quickstart video tutorial on how to set up your environment
|
|
[](http://www.youtube.com/watch?v=h05ufOsRgZU "Devcontainer quickstart guide").
|
|
|
|
|
|
### To deploy:
|
|
#### SC64
|
|
* Download the deployer [here](https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.18.0/sc64-deployer-windows-v2.18.0.zip)
|
|
* Extract and place `sc64deployer.exe` in the `tools/sc64` directory.
|
|
|
|
Make sure that your firmware is compatible (currently v2.18.0+)
|
|
See: [here](https://github.com/Polprzewodnikowy/SummerCart64/blob/v2.18.0/docs/00_quick_startup_guide.md#firmware-backupupdate)
|
|
|
|
##### From the devcontainer
|
|
It is not currently possible to directly communicate with USB devices.
|
|
BUT, as a workaround you can use a proxy TCP/IP connection
|
|
Set up a proxy: open a terminal window, `cd ./tools/sc64` and then `./sc64deployer.exe server`
|
|
|
|
Then in the dev container, use `make run` or `make run-debug`
|
|
|
|
|
|
##### From your host (Windows) OS
|
|
|
|
* Run `./localdeploy.bat` from the terminal
|
|
|
|
Toggle the N64 power switch to load the ROM.
|
|
|
|
`ms-vscode.makefile-tools` will help (installed automatically in dev container).
|
|
NOTE: it does not yet work with `F5`: see [this blog post](https://devblogs.microsoft.com/cppblog/now-announcing-makefile-support-in-visual-studio-code/)
|
|
WORKAROUND: in the dev container terminal, use make directly, i.e.: `make`
|
|
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](https://ares-emu.net/) (without most flashcart features).
|
|
|
|
* Ensure you have the Ares emulator on your computer.
|
|
* Load the `N64FlashcartMenu.n64` ROM.
|
|
|
|
#### Others
|
|
* Add the required file to the correct folder on your SD card.
|
|
|
|
|
|
## Update Libdragon submodule
|
|
This repo currently uses the `preview` branch as a submodule at a specific commit.
|
|
To update to the latest version, use `git submodule update --remote` from the terminal.
|
|
|
|
## Generate documentation
|
|
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`.
|
|
|
|
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
|
|
```
|