libmocha/README.md

28 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2022-06-09 19:11:30 +02:00
[![Publish Docker Image](https://github.com/wiiu-env/libmocha/actions/workflows/push_image.yml/badge.svg)](https://github.com/wiiu-env/libmocha/actions/workflows/push_image.yml)
**This library is still WIP, may not work as expected or have breaking changes in the near future**
2022-06-09 19:11:30 +02:00
# libmocha
Requires the [MochaPayload](https://github.com/wiiu-env/MochaPayload) to be running via [EnvironmentLoader](https://github.com/wiiu-env/EnvironmentLoader).
Requires [wut](https://github.com/devkitPro/wut) for building.
Install via `make install`.
## Usage
Make sure to add `-lmocha` to `LIBS` and `$(WUT_ROOT)/usr` to `LIBDIRS` in your makefile.
After that you can simply include `<mocha/mocha.h>` to get access to the mocha functions after calling `Mocha_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-04-01 07:55:07 +02:00
COPY --from=ghcr.io/wiiu-env/libmocha:[tag] /artifacts $DEVKITPRO
2022-06-09 19:11:30 +02:00
[...]
```
2023-04-01 07:55:07 +02:00
Replace [tag] with a tag you want to use, a list of tags can be found [here](https://github.com/orgs/wiiu-env/packages/container/libmocha/versions).
2022-06-09 19:11:30 +02:00
It's highly recommended to pin the version to the **latest date** instead of using `latest`.
## Format the code via docker
2023-04-01 07:55:07 +02:00
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source ./include -i`