mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-01-23 07:11:14 +01:00
75b14b6c20
## Description Documentaion has been rewritten/improved/expanded in certain areas including typo and formatting fixes. ## Motivation and Context Tidier documentation, to make things a bit more dumb-proof for end users. ## How Has This Been Tested? Not applicable. ## 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. - [x] I have updated the documentation accordingly. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. Signed-off-by: IlDucci <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit - **Documentation** - Updated documentation for initial SD card setup, menu controls, and menu customization. - Improved clarity and readability of instructions. - Refined section headings and formatting across multiple documentation files. - Added new sections explaining menu settings, ROM information, and control details. - Emphasized warnings regarding filename compatibility and save file issues. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
73 lines
3.1 KiB
Markdown
73 lines
3.1 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").
|
|
|
|
|
|
### How to deploy
|
|
#### SC64
|
|
* Download the deployer [here](https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.20.0/sc64-deployer-windows-v2.20.0.zip).
|
|
* Extract and place `sc64deployer.exe` in the `tools/sc64` directory.
|
|
|
|
Make sure that your firmware is compatible (currently v2.20.0+).
|
|
See: [here](https://github.com/Polprzewodnikowy/SummerCart64/blob/v2.20.0/docs/00_quick_startup_guide.md#firmware-backupupdate)
|
|
|
|
##### From the devcontainer
|
|
It is not currently possible to directly communicate with USB devices. BUT, you can use a proxy TCP/IP connection as a workaround.
|
|
To 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 submodules
|
|
To update to the latest version, use `git submodule update --remote` from the terminal.
|
|
|
|
### libdragon
|
|
This repo currently uses the `preview` branch as a submodule at a specific commit.
|
|
* To ensure your local instance is building against it, use `cd ./libdragon && make clobber -j && make libdragon tools -j && make install tools-install -j && cd ..`
|
|
|
|
## 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
|
|
Testing the documentation locally allows you to preview changes and ensure everything renders correctly before submitting your changes.
|
|
|
|
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
|
|
```
|