Skip to content

Commit

Permalink
docs: remove environment variable requirement from UNF and instead us…
Browse files Browse the repository at this point in the history
…e executable on PATH
  • Loading branch information
anacierdem committed Sep 30, 2024
1 parent 3ff7e52 commit b8a3ecc
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
15 changes: 12 additions & 3 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
"type": "cppvsdbg",
"request": "launch",
"name": "Test Bench",
"program": "${env:UNF_LOADER}",
"windows": {
"program": "UNFLoader.exe"
},
"program": "UNFLoader",
"args": ["-b", "-d", "-r", "${workspaceFolder}/src/test_bench.z64"],
"preLaunchTask": "build",
"console": "integratedTerminal"
Expand All @@ -31,7 +34,10 @@
"type": "cppvsdbg",
"request": "launch",
"name": "Tests",
"program": "${env:UNF_LOADER}",
"windows": {
"program": "UNFLoader.exe"
},
"program": "UNFLoader",
"args": [
"-b",
"-d",
Expand All @@ -58,7 +64,10 @@
"type": "cppvsdbg",
"request": "launch",
"name": "Run selected example",
"program": "${env:UNF_LOADER}",
"windows": {
"program": "UNFLoader.exe"
},
"program": "UNFLoader",
"args": [
"-b",
"-d",
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ The root `bench` recipe is for building the code in root `src` folder. This is a
There are also vscode launch configurations to quickly build the examples, tests and the bench. If you have the `N64_EMU` environment variable set pointing at your favourite emulator ([ares](https://ares-emu.net/) is highly recommended), the launch configurations ending in `(emu)` will kick your emulator with the selected example/code. You can also just hit F5 to launch the selected configuration. For the examples configuration, you can navigate to the relevant `.c` file and `Run selected example` will start it most of the time. In some cases, the output ROM name may not match the `.c` file and in those cases, you can select the ROM file and it should work.

> [!NOTE]
> This repository also uses [UNFLoader](https://github.com/buu342/N64-UNFLoader), so you can use the launch configurations without `(emu)` to run the code if you have a supported flashcart plugged in and have `UNF_LOADER` environment variable pointing at the executable.
> This repository also uses [UNFLoader](https://github.com/buu342/N64-UNFLoader), so you can use the launch configurations without `(emu)` to run the code if you have a supported flashcart plugged in and have UNFLoader executable on your `PATH`.
You can clean everything with the `clean` recipe/task (open the command palette and choose `Run Task -> clean`).

Expand Down

0 comments on commit b8a3ecc

Please sign in to comment.