libsdutils/README.md

29 lines
1.2 KiB
Markdown
Raw Normal View History

2022-03-03 23:50:19 +01:00
[![Publish Docker Image](https://github.com/wiiu-env/libsdutils/actions/workflows/push_image.yml/badge.svg)](https://github.com/wiiu-env/libsdutils/actions/workflows/push_image.yml)
# libsdutils
Requires the [SDHotSwapModule](https://github.com/wiiu-env/SDHotSwapModule) 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 `-lkernel` to `LIBS` and `$(WUMS_ROOT)` to `LIBDIRS`.
After that you can simply include `<sdutils/sdutils.h>` to get access to the sdutils 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/libsdutils:[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/libsdutils/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`