libmappedmemory/README.md

36 lines
1.5 KiB
Markdown
Raw Normal View History

2022-02-11 20:43:38 +01:00
[![Publish Docker Image](https://github.com/wiiu-env/libmappedmemory/actions/workflows/push_image.yml/badge.svg)](https://github.com/wiiu-env/libmappedmemory/actions/workflows/push_image.yml)
2021-04-07 16:37:14 +02:00
# libmemorymapping
Requires the [MemoryMappingModule](https://github.com/wiiu-env/MemoryMappingModule) to be running via [WUMSLoader](https://github.com/wiiu-env/WUMSLoader).
Requires [wut](https://github.com/devkitPro/wut) for building.
2021-04-07 16:37:14 +02:00
Install via `make install`.
## Usage
When linking, make sure to add the `libmappedmemory.ld` file to the LDFLAGS.
Example:
```
LDFLAGS = -g $(ARCH) $(RPXSPECS) -Wl,-Map,$(notdir $*.map) -T$(WUMS_ROOT)/share/libmappedmemory.ld
```
Make also sure to define
```
WUMS_ROOT := $(DEVKITPRO)/wums
```
and add `-lmappedmemory` to `LIBS` and `$(WUMS_ROOT)` to `LIBDIRS`.
After that you can simply include `<memory/mappedmemory.h>` to get access to the memory functions.
## 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:49:56 +02:00
COPY --from=ghcr.io/wiiu-env/libmappedmemory:[tag] /artifacts $DEVKITPRO
2021-04-07 16:37:14 +02:00
[...]
```
2023-04-01 07:49:56 +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/libmappedmemory/versions).
2022-02-11 20:43:38 +01: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:49:56 +02:00
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source ./include -i`