Update 99_developer_guide.md

Add debug example.
Improve tips.
Improvements for readability.

Author: networkfusion

docs/99_developer_guide.md

@@ -1,7 +1,8 @@
 [Return to the index](./00_index.md)
 ## Developer Guide
 
-You can use a dev container in VSCode to ease development.
+> [!TIP]
+> You should use the pre-configured dev container in VSCode to ensure easy development.
 
 Expected pre-requsites:
 * [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation) container environment (for dev container support).
@@ -10,23 +11,35 @@ Expected pre-requsites:
 ### A quick start video tutorial on how to set up your environment
 [![Docker Devcontainer quick start guide](http://img.youtube.com/vi/h05ufOsRgZU/0.jpg)](http://www.youtube.com/watch?v=h05ufOsRgZU "Docker Devcontainer quick start guide").
 
+## How to build the ROM
+In the terminal, use make directly, i.e.: `make all`.  
+The ROMs can be found in the `output` directory.
+
+For the future:
+`ms-vscode.makefile-tools` will hopefully 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/).  
 
-### How to deploy
-#### SC64
-* Download the deployer [here](https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.20.2/sc64-deployer-windows-v2.20.2.zip).
-* Extract and place `sc64deployer.exe` in the `tools/sc64` directory.
 
+## How to deploy and/or debug to the SC64
 Make sure that your firmware is compatible (currently v2.20.2+).
 See: [here](https://github.com/Polprzewodnikowy/SummerCart64/blob/v2.20.2/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`.
+You will need to download a copy of the `sc64deployer` from [here](https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.20.2/) or build your own depending on the scenario.
+
+> [!TIP]
+> Toggle the N64 POWER switch to load and run the ROM.
+
+### From within the devcontainer
+#### To the native OS
+It is not currently possible to directly communicate with USB devices from a devcontainer. BUT, you can use a proxy TCP/IP connection as a workaround.  
+To set up a "proxy", open a terminal window on the native OS, then `cd ./tools/sc64` and then `./sc64deployer.exe server`.
+Keep this terminal window open.
 
 Then, in the dev container, use `make run` or `make run-debug`.
 
+#### To a remote LAN device
 If you want to Deploy and debug to a fully remote target (over your LAN)
-Make sure that the remote target has the server running:
+Make sure that the remote target device (i.e. the one with the carts USB connected) has the server running (similar as specified in To the native OS, but):
 
 > [!TIP]
 > Make sure you specify its accessible IP and port.
@@ -38,35 +51,51 @@ Make sure that the remote target has the server running:
 
 The following commands can then be run from the docker environment terminal:
 
+To upload and run the ROM (requires power toggle):
 ```
-sc64deployer --remote [THE_LAN_IP_ADDRESS]:9064 upload ./output/N64FlashcartMenu.n64
-sc64deployer --remote [THE_LAN_IP_ADDRESS]:9064 debug --no-writeback --init "send-file /sc64menu.n64 @output/sc64menu.n64@;reboot"
+REMOTE=[THE_LAN_IP_ADDRESS]:9064 make run
 ```
 
+To debug the ROM:
+```
+REMOTE=[THE_LAN_IP_ADDRESS]:9064 make run-debug
+```
 
-##### From your host (Windows) OS
-
-* Run `./localdeploy.bat` from the terminal.
-
-Toggle the N64 POWER switch to load the ROM.
+### Directly From your host (Windows) OS
+* Download the deployer [here](https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.20.2/sc64-deployer-windows-v2.20.2.zip).
+* Extract and place `sc64deployer.exe` in the `tools/sc64` directory.
+* Then use `make run` or `make run-debug` in the terminal.
 
-`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.
 
+### To an SD Card
 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
+
+## How to deploy and/or debug to other flashcarts/emulators
+### Ares Emulator
 For ease of development and debugging, the N64FlashcartMenu 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
+### Others
 * Add the required file to the correct folder on your SD card.
 
 
+## How to add debug code
+Within the code, use the `debugf` command, and then deploy using a debug build e.g. `make run-debug`.
+
+```c
+    debugf("joybus_rtc_detect_async: %s %s %s %s\n",
+        detected ? "detected" : "not detected",
+        status.stopped ? "stopped" : "running",
+        status.crystal_bad ? "crystal:BAD" : "crystal:OK",
+        status.battery_bad ? "battery:BAD" : "battery:OK"
+    );
+```
+The output will then be shown within the terminal.
+
+
 ## Update submodules
 To update to the latest version, use `git submodule update --remote` from the terminal.