7f97c2ff4e
## Description Proofread and partial rewrite of the docs. ## Motivation and Context Adding more information written in an user-friendly way (not just developer-friendly way), writing materials that were left to do, cleaning up existing materials. ## 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: - [ ] 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. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated multiple documentation files with improved clarity, consistency, and formatting - Refined section titles and headings across various documentation pages - Enhanced explanations and instructions for N64FlashcartMenu features - Improved navigation links and added more descriptive return-to-index references <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Robin Jones <networkfusion@users.noreply.github.com>
3.2 KiB
Developer Guide
You can use a dev container in VSCode to ease development.
A quick start video tutorial on how to set up your environment
.
How to deploy
SC64
- Download the deployer here.
- Extract and place
sc64deployer.exein thetools/sc64directory.
Make sure that your firmware is compatible (currently v2.20.0+). See: here
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.batfrom 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.
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 generated by running make all or running make sc64. You can then copy the resulting sc64menu.n64 file to your SD card.
Ares Emulator
For ease of development and debugging, the N64FlashcartMenu ROM can run in the Ares emulator (without most flashcart features).
- Ensure you have the Ares emulator on your computer.
- Load the
N64FlashcartMenu.n64ROM.
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.
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:
apt-get install ruby-full build-essential zlib1g-dev
gem install jekyll bundler
You can then serve the webpage:
cd output/docs && jekyll serve