diff --git a/.gitignore b/.gitignore index 00a62912..451eb336 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ /.vscode /build +tools/sc64/sc64.exe diff --git a/README.md b/README.md index e9e5b32b..fce2ab4a 100644 --- a/README.md +++ b/README.md @@ -53,10 +53,19 @@ The aim is to replace [Altra64](https://github.com/networkfusion/altra64) and [E # Developer documentation **Work in progress!** -You can use a dev container in VSCode. +You can use a dev container in VSCode to ease development. + +Note: the dev container currently downloads and installs the latest available libdragon from the stable branch, rather than use the repos submodule. + +To deploy: +* Download the deployer [here](https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.12.1/sc64-windows-v2.12.1.zip) +* Extract and place `sc64.exe` in the `tools/sc64` directory +* For the moment, deployment cannot happen within the dev container and you must do it from a terminal on the host. +* Run `./deploy.bat` from the terminal (in windows) `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 terminal, use make directly `make all` then `make finalize-sc64` -The ROM will be found in the `build` directory. +WORKAROUND: in the dev container terminal, use make directly `make all` +The ROM can be found in the `build` directory. +NOTE: a "release" version of the ROM is called `sc64menu.n64` is created for when you want to add it directly to the SDCard. diff --git a/deploy.bat b/deploy.bat index 33f6f66e..4b8109ed 100644 --- a/deploy.bat +++ b/deploy.bat @@ -1,4 +1,8 @@ :: Make sure we are connected -./tools/sc64/sc64.exe --print-state +cd %~dp0tools\sc64\ +sc64 --print-state + :: Boot the menu -./tools/sc64/sc64.exe --boot direct-rom --rom ./build/sc64menu.n64 \ No newline at end of file +sc64 --boot direct-rom %~dp0build\N64FlashcartMenu.z64 + +::pause