Skip to content

Commit

Permalink
Update README and change suggested install path
Browse files Browse the repository at this point in the history
  • Loading branch information
rw-r-r-0644 committed Feb 19, 2019
1 parent 08bc8c6 commit 1812559
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 55 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## libromfs-wiiu

### Informations
This library implements an embedded filesystem mountpoint for usage with devkitPPC aimed at the Nintendo Wii U. The implementations works by statically linking the romfs directory compressed with ustar to the executable.

### Usage
Include library's header: `#include <romfs-wiiu.h>`
Call `romfsInit()` at the start of you app and `romfsExit()` before exiting

To generate the romfs, define a ROMFS variable in you makefile containing the path of your romfs folder:

ROMFS := romfs_example_folder
Then, include romfs's makefile and add romfs target to your linking targets along with the ld flags (chage the example according to your makefile):

include $(DEVKITPRO)/portlibs/wiiu/share/romfs-wiiu.mk
OBJECTS += $(ROMFS_TARGET)
LDFLAGS += $(ROMFS_LDFLAGS)

### Installing
A prebuild version is available at the wiiu-fling pacman repository.
Please reffer to [these](https://gitlab.com/QuarkTheAwesome/wiiu-fling) instructions to set up wiiu-fling.

To manually install the library:

$ git clone https://github.com/yawut/libromfs-wiiu.git
$ cd libromfs-wiiu
$ mkdir build && cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=$DEVKITPRO/portlibs/wiiu
$ make
$ sudo make install



55 changes: 0 additions & 55 deletions README.txt

This file was deleted.

0 comments on commit 1812559

Please sign in to comment.