Update the README

This commit is contained in:
Maschell 2022-02-13 15:09:16 +01:00
parent 2eae70a247
commit 36aee0481f

View File

@ -1,3 +1,20 @@
Requires the [WiiUPluginLoaderBackendModule](https://github.com/wiiu-env/WiiUPluginLoaderBackend) to be running via [SetupPayload](https://github.com/wiiu-env/SetupPayload).
Requires [wut](https://github.com/decaf-emu/wut) for building.
Install via `make install`.
## libwupsbackend
Requires the [WiiUPluginLoaderBackendModule](https://github.com/wiiu-env/WiiUPluginLoaderBackend) to be running via [WUMSLoader](https://github.com/wiiu-env/WUMSLoader).
Requires [wut](https://github.com/devkitpro/wut) for building.
Install via `make install`.
## Building
Make you to have [wut](https://github.com/devkitPro/wut/) installed and use the following command for build:
```
make install
```
## Use this lib in Dockerfiles.
A prebuilt version of this lib can found on dockerhub. To use it for your projects, add this to your Dockerfile.
```
[...]
COPY --from=wiiuenv/libwupsbackend:[tag] /artifacts $DEVKITPRO
[...]
```
Replace [tag] with a tag you want to use, a list of tags can be found [here](https://hub.docker.com/r/wiiuenv/libwupsbackend/tags).
It's highly recommended to pin the version to the **latest date** instead of using `latest`.