[Meta] Add a simple contributing guide (#257)

* Add simple contribution guide

* Browser Exploit should take about 20 seconds
pull/259/head
Ben Stolovitz 11 months ago committed by GitHub
parent 6f626f6073
commit 3088a60d1e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -2,4 +2,29 @@
Nintendo Wii U homebrew guide written by staff members of the [Nintendo Homebrew Discord server.](https://discord.gg/C29hYvh)
[The guide can be found here!](https://wiiu.hacks.guide/)
https://wiiu.hacks.guide/
## Running the site locally
This requires the following installed on your system:
* [node.js](https://nodejs.org/en)
To test the website locally, clone the source code:
```bash
git clone https://github.com/hacks-guide/Guide-WiiU.git --recurse-submodules
cd Guide-WiiU
```
> [!NOTE]
> You must use `--recurse-modules` or you will hit an error like `Failed to resolve import "@theme/index" from "node_modules/vitepress/dist/client/app/index.js?v=19e6628c"` when running. If you've already cloned, you can initialize the submodules manually: `git submodule update --init --recursive`.
Then simply run the following commands:
```bash
npm ci
npm run docs:dev
```
The website should now be running on http://127.0.0.1:5173/ (or a port shown on the terminal). Any edits you make should appear live!

@ -11,7 +11,7 @@ Make sure your Wii U has internet access for this step.
1. Take the SD Card out of your computer and plug it into your Wii U console.
1. Launch the Internet Browser and navigate to the website `wiiuexploit.xyz`.
1. Click on `Run Exploit!` and hold the B button until you see this menu, it will be necessary for the next steps.
1. Click on `Run Exploit!` and hold the B button until you see this menu (about 20s), it will be necessary for the next steps.
![](/assets/img/guide/PLL.png)
- If your Wii U gets stuck on a white or otherwise frozen screen, wait a few seconds. If nothing happens, reboot the console, [reset the browser's save data](https://en-americas-support.nintendo.com/app/answers/detail/a_id/1507/~/how-to-delete-the-internet-browser-history) and try again.
- If you see the EnvironmentLoader, you did not hold down B long enough. Try again.

Loading…
Cancel
Save