libnotifications/README.md

29 lines
1.4 KiB
Markdown
Raw Normal View History

2023-01-21 21:33:00 +01:00
[![Publish Docker Image](https://github.com/wiiu-env/libnotifications/actions/workflows/push_image.yml/badge.svg)](https://github.com/wiiu-env/libnotifications/actions/workflows/push_image.yml)
# libnotifications
Requires the [NotificationModule](https://github.com/wiiu-env/NotificationModule) 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 also sure to define
```
WUMS_ROOT := $(DEVKITPRO)/wums
```
and add `-lnotifications` to `LIBS` and `$(WUMS_ROOT)` to `LIBDIRS`.
After that you can simply include `<notifications/notifications.h>` to get access to the function patcher functions after calling `NotificationModule_InitLibrary()`.
## 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.
```
[...]
2023-03-16 16:29:20 +01:00
COPY --from=ghcr.io/wiiu-env/libnotifications:[tag] /artifacts $DEVKITPRO
2023-01-21 21:33:00 +01:00
[...]
```
2023-03-16 16:29:20 +01:00
Replace [tag] with a tag you want to use, a list of tags can be found [here](https://github.com/wiiu-env/libnotifications/pkgs/container/libnotifications/versions).
2023-01-21 21:33:00 +01:00
It's highly recommended to pin the version to the **latest date** instead of using `latest`.
## Format the code via docker
2023-03-16 16:29:20 +01:00
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source ./include -i`