The-Homebrew-Cloud/libmappedmemory
2
0
Fork 0
mirror of https://github.com/wiiu-env/libmappedmemory.git synced 2024-11-25 11:16:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update the README

Browse Source
This commit is contained in:
Maschell 2021-04-07 16:37:14 +02:00
parent 5cedb9b0c5
commit 4cfe75a5b8
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -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`.
## 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`.