Improve readme

Specifically for ED64 V3
This commit is contained in:
Robin Jones 2023-12-24 22:39:59 +00:00
parent c08002698f
commit d5a18c573b

View File

@ -89,6 +89,12 @@ Download the `ED64P.v64` ROM from the latest action run assets and place it in t
You can use a dev container in VSCode to ease development. You can use a dev container in VSCode to ease development.
## To Build:
`ms-vscode.makefile-tools` will help (installed automatically in dev container).
TODO: it does not yet work with `F5`: see 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 all`
The ROMs can be found in the `output` directory.
## To deploy: ## To deploy:
### SC64 ### SC64
@ -113,15 +119,19 @@ Then in the dev container, use `make run` or `make run-debug`
Toggle the N64 power switch to load the ROM. Toggle the N64 power switch to load the ROM.
`ms-vscode.makefile-tools` will help (installed automatically in dev container). #### From the SD Card
TODO: it does not yet work with `F5`: see https://devblogs.microsoft.com/cppblog/now-announcing-makefile-support-in-visual-studio-code/ 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 root folder on the SDCard. This is generated by running `make all` or running `make sc64`.
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`.
### Others ### ED64 V3 over USB from your host (Windows) OS
* Download the UNFLoader [here](https://github.com/buu342/N64-UNFLoader/releases/download/v2.11/UNFLoader-Windows-x86.zip)
* Extract and place `UNFLoader.exe` in the `tools` directory.
* Ensure the current "official menu" is `V3.06`.
* Run the appropriate command from windows cmd prompt to ensure your current directory is the root project directory.
* Upload the ROM (e.g. `./tools/UNFLoader.exe -r ./output/OS64.v64`)
### Others (non USB)
* Add the required file to the correct folder on your SD card. * Add the required file to the correct folder on your SD card.