diff --git a/README.md b/README.md index 76eb39a..704f87a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![CI-Release](https://github.com/wiiu-env/NotificationModule/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/NotificationModule/actions/workflows/ci.yml) +[![CI release](https://github.com/wiiu-env/NotificationModule/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/NotificationModule/actions/workflows/ci.yml) See [libnotifications](https://github.com/wiiu-env/libnotifications). @@ -8,7 +8,7 @@ See [libnotifications](https://github.com/wiiu-env/libnotifications). 1. Copy the file `NotificationModule.wms` into `sd:/wiiu/environments/[ENVIRONMENT]/modules`. 2. Requires the [WUMSLoader](https://github.com/wiiu-env/WUMSLoader) in `sd:/wiiu/environments/[ENVIRONMENT]/modules/setup`. -## Buildflags +## Build flags ### Logging Building via `make` only logs errors (via OSReport). To enable logging via the [LoggingModule](https://github.com/wiiu-env/LoggingModule) set `DEBUG` to `1` or `VERBOSE`. @@ -17,7 +17,7 @@ Building via `make` only logs errors (via OSReport). To enable logging via the [ `make DEBUG=1` Enables information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule). `make DEBUG=VERBOSE` Enables verbose information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule). -If the [LoggingModule](https://github.com/wiiu-env/LoggingModule) is not present, it'll fall back to UDP (Port 4405) and [CafeOS](https://github.com/wiiu-env/USBSerialLoggingModule) logging. +If the [LoggingModule](https://github.com/wiiu-env/LoggingModule) is not present, it'll fall back to UDP (port 4405) and [CafeOS](https://github.com/wiiu-env/USBSerialLoggingModule) logging. ## Building using the Dockerfile @@ -34,6 +34,6 @@ docker run -it --rm -v ${PWD}:/project notificationmodule-builder make docker run -it --rm -v ${PWD}:/project notificationmodule-builder make clean ``` -## Format the code via docker +## Format the code via Docker -`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./src -i` \ No newline at end of file +`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./src -i`