mirror of
https://github.com/wiiu-env/libmappedmemory.git
synced 2024-11-14 05:55:08 +01:00
Update the README
This commit is contained in:
parent
5cedb9b0c5
commit
4cfe75a5b8
29
README.md
29
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`.
|
||||
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`.
|
Loading…
Reference in New Issue
Block a user