Add usage instruction to readme (#32)

* Add usage instruction to readme

* Also mention loading homebrew
This commit is contained in:
Volker Schlegel 2024-09-08 00:06:34 +02:00 committed by GitHub
parent 8854ff3f90
commit cd2841ac0c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,6 +1,9 @@
[![CI-Release](https://github.com/wiiu-env/wiiload_plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/wiiload_plugin/actions/workflows/ci.yml)
## Usage
Use the wiiload executable (located in `[DEVKITPRO]/tools/bin`) to send your plugin or homebrew (.rpx or .wuhb) to your WiiU.
## Installation
(`[ENVIRONMENT]` is a placeholder for the actual environment name.)
1. Copy the file `wiiload.wps` into `sd:/wiiu/environments/[ENVIRONMENT]/plugins`.
@ -36,4 +39,4 @@ docker run -it --rm -v ${PWD}:/project wiiloadplugin-builder make clean
## Format the code via docker
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./src -i`
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./src -i`