mirror of
https://github.com/wiiu-env/libwuhbutils.git
synced 2024-11-24 11:59:16 +01:00
32 lines
1.3 KiB
Markdown
32 lines
1.3 KiB
Markdown
[](https://github.com/wiiu-env/libwuhbutils/actions/workflows/push_image.yml)
|
|
|
|
# libwuhbutils
|
|
Requires the [WUHBUtilsModule](https://github.com/wiiu-env/WUHBUtilsModule) to be running via [WUMSLoader](https://github.com/wiiu-env/WUMSLoader).
|
|
Requires [wut](https://github.com/devkitPro/wut) for building.
|
|
Install via `make install`.
|
|
|
|
## Usage
|
|
Make sure to define
|
|
```
|
|
WUMS_ROOT := $(DEVKITPRO)/wums
|
|
```
|
|
and add `-lwuhbutils` to `LIBS` and `$(WUMS_ROOT)` to `LIBDIRS`.
|
|
|
|
After that you can simply include `<wuhb_utils/utils.h>`, to get access to WUHBUtils function.
|
|
|
|
To init the library call `WUHBUtils_Init()` and check for the `WUHB_UTILS_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.
|
|
```
|
|
[...]
|
|
COPY --from=wiiuenv/libwuhbutils:[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/libwuhbutils/tags).
|
|
It's highly recommended to pin the version to the **latest date** instead of using `latest`.
|
|
|
|
## Format the code via docker
|
|
|
|
`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./source ./include -i`
|