From 4cfe75a5b8bf79a6bc9bb614192e0260eb3c7b79 Mon Sep 17 00:00:00 2001 From: Maschell Date: Wed, 7 Apr 2021 16:37:14 +0200 Subject: [PATCH] Update the README --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e881280..397bd98 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ +# libmemorymapping Requires the [MemoryMappingModule](https://github.com/wiiu-env/MemoryMappingModule) to be running via [SetupPayload](https://github.com/wiiu-env/SetupPayload). Requires [wut](https://github.com/decaf-emu/wut) for building. -Install via `make install`. \ No newline at end of file +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 `` 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`. \ No newline at end of file