The-Homebrew-Cloud/librpxloader
2
0
Fork 0
mirror of https://github.com/wiiu-env/librpxloader.git synced 2024-11-21 17:59:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update the README

Browse Source
This commit is contained in:
Maschell 2021-04-07 16:07:54 +02:00
parent 6874069056
commit 80595c29ab
1 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -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
```
```
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 `<rpxloader.h>` 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`.