From 80595c29ab91ad23c230e150e1842ccfa10c2430 Mon Sep 17 00:00:00 2001 From: Maschell Date: Wed, 7 Apr 2021 16:07:54 +0200 Subject: [PATCH] Update the README --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cfa8d98..f622bce 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,28 @@ Requires the [RPXLoadingModule](https://github.com/wiiu-env/RPXLoadingModule) to Requires [wut](https://github.com/decaf-emu/wut) for building. Install via `make install`. -# Usage -When linking, make sure to add the librpxloader.ld file to the LDFLAGS. +## Usage +When linking, make sure to add the `librpxloader.ld` file to the LDFLAGS. Example: ``` LDFLAGS = -g $(ARCH) $(RPXSPECS) -Wl,-Map,$(notdir $*.map) -T$(WUMS_ROOT)/share/librpxloader.ld -``` \ No newline at end of file +``` + +Make also sure to define +``` +WUMS_ROOT := $(DEVKITPRO)/wums +``` +and add `-lrpxloader` to `LIBS` and `$(WUMS_ROOT)` to `LIBDIRS`. + +After that you can simply include `` to get access to the RPXLoader functions. + +## 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/librpxloader:[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/librpxloader/tags). +It's highly recommended to pin the version to the **latest date** instead of using `latest`. \ No newline at end of file