mirror of
https://github.com/wiiu-env/libmappedmemory.git
synced 2024-11-17 07:19:21 +01:00
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
[](https://github.com/wiiu-env/libmappedmemory/actions/workflows/push_image.yml)
|
|
|
|
# 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.
|
|
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.
|
|
```
|
|
[...]
|
|
COPY --from=wiiuenv/libmappedmemory:[tag] /artifacts $DEVKITPRO
|
|
[...]
|
|
```
|
|
Replace [tag] with a tag you want to use, a list of tags can be found [here](https://hub.docker.com/r/wiiuenv/libmappedmemory/tags).
|
|
It's highly recommended to pin the version to the **latest date** instead of using `latest`.
|
|
|
|
## Format the code via docker
|
|
|
|
`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./source ./include -i` |