From 18c50471e20ca4002139aedd8ce9863565612184 Mon Sep 17 00:00:00 2001 From: Ocarinaoftime <89474990+Ocarinaoftime@users.noreply.github.com> Date: Wed, 2 Oct 2024 11:05:55 -0400 Subject: [PATCH] Update README.md with instructions on how to run --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21c3d74..0e241bb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ -# Wii-Shop-EC-Log-Dumper -This is a script to dump the EC Log from the Wii Shop Channel to a text file. +# Wii Shop EC Log Dumper +This is a script to dump the EC Log from the Wii Shop Channel to a text file.
+*Only useful when debugging on real hardware, as you can access the EC Log on Dolphin through OSReport (see https://wiibrew.org/wiki/Accessing_Wii_Shop_Channel_from_PC)* +## How to use +* In a terminal/cmd window, do `git clone https://github.com/Ocarinaoftime/Wii-Shop-EC-Log-Dumper.git` +* `cd` into `Wii-Shop-EC-Log-Dumper` +* Make sure you have NodeJS installed and have expressjs installed +* Simply run `node main.js` to start the server. +* Link the file in this repository called `debug.html` to a route in your server. +* When in the Wii Shop Channel, head to the debug.html page +* Click `Send log to server` and look at the file created on the computer running the script +* Boom!