mirror of
https://github.com/wiiu-env/librpxloader.git
synced 2024-11-21 17:59:17 +01:00
Update README.md
This commit is contained in:
parent
56047bb65f
commit
8c490d7990
14
README.md
14
README.md
@ -6,20 +6,16 @@ Requires [wut](https://github.com/devkitPro/wut) for building.
|
||||
Install via `make install`.
|
||||
|
||||
## 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
|
||||
Make 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.
|
||||
After that you can simply include `<rpxloader/rpxloader.h>` to get access to the RPXLoader functions.
|
||||
|
||||
To init the library call `RPXLoader_Init()` and check for the `RPX_LOADER_RESULT_SUCCESS` return code.
|
||||
|
||||
## 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.
|
||||
@ -33,4 +29,4 @@ It's highly recommended to pin the version to the **latest date** instead of usi
|
||||
|
||||
## Format the code via docker
|
||||
|
||||
`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./source ./include -i`
|
||||
`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./source ./include -i`
|
||||
|
Loading…
Reference in New Issue
Block a user