libgui/README.md

52 lines
1.4 KiB
Markdown
Raw Normal View History

2017-10-29 10:28:14 +01:00
# libgui
2018-06-21 20:44:58 +02:00
[![Build Status](https://travis-ci.org/Maschell/libgui.svg?branch=wut)](https://travis-ci.org/Maschell/libgui/tree/wut)
2017-10-29 10:28:14 +01:00
## Usage
Following steps are required for initialization:
```C
2017-10-29 10:28:14 +01:00
memoryInitialize(); // Initialize memory management
//DO GUI STUFF HERE!
memoryRelease();
```
Link the application with:
```Makefile
2018-06-21 20:44:58 +02:00
-lgui -lutilswut -lfreetype -lgd -lpng -ljpeg -lz -lmad -lvorbisidec
2017-10-29 10:28:14 +01:00
```
2017-11-11 16:18:13 +01:00
You also need to add the include path to your Makefile. Example:
```Makefile
2017-11-11 16:18:13 +01:00
export INCLUDE := [...] -I$(PORTLIBS)/include/freetype2 \
2018-06-21 20:44:58 +02:00
-I$(WUT_ROOT)/include/libgui \
2017-11-11 16:18:13 +01:00
-I$(PORTLIBS)/include
```
2017-10-29 10:28:14 +01:00
TODO: provide more information
## Dependencies
To be able to use libgui, you need to install the following dependencies:
- Application needs to be loaded from the [homebrew_launcher](https://github.com/dimok789/homebrew_launcher)
2018-06-21 20:44:58 +02:00
- [libutils](https://github.com/Maschell/libutils/tree/wut) (WUT branch) for common functions.
- [wut](https://github.com/decaf-emu/wut)
2017-10-29 10:28:14 +01:00
2018-06-21 20:44:58 +02:00
And other portable libraries that can be found in the "libs" folder of this repository. Extract the "portlibs.zip" into your devkitPro directory.
`7z x -y ./libs/portlibs.zip -o${DEVKITPRO}`
2017-10-29 10:28:14 +01:00
This package includes:
- freetype2
- libgd
- libpng
- libjpeg
- libz
- libmad
- vorbisidec
# Credits
- Orignally based on https://github.com/dborth/libwiigui
- Wii U port / modification / new functions / sound / much more by dimok.
- Minor changes by Maschell