mirror of
https://github.com/wiiu-env/USBSerialLoggingModule.git
synced 2024-11-28 12:54:15 +01:00
26 lines
1016 B
Markdown
26 lines
1016 B
Markdown
[](https://github.com/wiiu-env/USBSerialLoggingModule/actions/workflows/ci.yml)
|
|
|
|
## Usage
|
|
(`[ENVIRONMENT]` is a placeholder for the actual environment name.)
|
|
|
|
1. Copy the file `USBSerialLoggingModule.wms` into `sd:/wiiu/environments/[ENVIRONMENT]/modules`.
|
|
2. Requires the [WUMSLoader](https://github.com/wiiu-env/WUMSLoader) in `sd:/wiiu/environments/[ENVIRONMENT]/modules/setup`.
|
|
|
|
## 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 usbserialloggermodule-builder
|
|
|
|
# make
|
|
docker run -it --rm -v ${PWD}:/project usbserialloggermodule-builder make
|
|
|
|
# make clean
|
|
docker run -it --rm -v ${PWD}:/project usbserialloggermodule-builder make clean
|
|
```
|
|
|
|
## Format the code via docker
|
|
|
|
`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./source -i` |