KernelModule/README.md

26 lines
968 B
Markdown
Raw Normal View History

2022-02-04 17:35:49 +01:00
[![CI-Release](https://github.com/wiiu-env/KernelModule/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/KernelModule/actions/workflows/ci.yml)
2022-01-30 16:52:04 +01:00
## Usage
(`[ENVIRONMENT]` is a placeholder for the actual environment name.)
1. Copy the file `KernelModule.wms` into `sd:/wiiu/environments/[ENVIRONMENT]/modules`.
2. Requires the [WUMSLoader](https://github.com/wiiu-env/WUMSLoader) in `sd:/wiiu/environments/[ENVIRONMENT]/modules/setup`.
2020-07-05 13:18:50 +02:00
## Building using the Dockerfile
It's possible to use a docker image for building. This way you don't need anything installed on your host system.
```
# Build docker image (only needed once)
docker build . -t kernelmodule-builder
# make
docker run -it --rm -v ${PWD}:/project kernelmodule-builder make
# make clean
docker run -it --rm -v ${PWD}:/project kernelmodule-builder make clean
2022-02-04 17:35:49 +01:00
```
## Format the code via docker
2023-03-28 20:28:51 +02:00
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source -i`