mirror of
https://github.com/wiiu-env/SDHotSwapModule.git
synced 2024-11-13 07:05:14 +01:00
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
|
[![CI-Release](https://github.com/wiiu-env/SDHotSwapModule/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/SDHotSwapModule/actions/workflows/ci.yml)
|
||
|
|
||
|
## SDHotSwapModule
|
||
|
|
||
|
Automatically (un)mounts the sd card when the sd card was inserted/ejected. See [libsdutils](https://github.com/wiiu-env/libsdutils) to have an easy way to register a callback for these events.
|
||
|
|
||
|
## Usage
|
||
|
(`[ENVIRONMENT]` is a placeholder for the actual environment name.)
|
||
|
|
||
|
1. Copy the file `SDHotSwapModule.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 sdhotswapmodule-builder
|
||
|
|
||
|
# make
|
||
|
docker run -it --rm -v ${PWD}:/project sdhotswapmodule-builder make
|
||
|
|
||
|
# make clean
|
||
|
docker run -it --rm -v ${PWD}:/project sdhotswapmodule-builder make clean
|
||
|
```
|
||
|
|
||
|
## Format the code via docker
|
||
|
|
||
|
`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./source -i`
|