From d9111d58733d2ee3b9f8ec47cd0f8a5fadc95c40 Mon Sep 17 00:00:00 2001
From: rw-r-r-0644 <r.r.qwertyuiop.r.r@gmail.com>
Date: Sat, 12 Jan 2019 13:08:15 +0100
Subject: [PATCH] Add README.md for the WiiU port

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..4218e046e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+## SDL2 for Wii U
+
+### About  
+This project is a port of the **SDL** software development library to the Nintendo Wii U video game console, built for the wut toolchain.
+Currently it implements support for audio, joystick (gamepad), touchscreen (gamepad), video (gx2), hardware accelerated rendering (gx2), timers and threading.
+
+### Installing  
+Prebuilt versions of sdl2, along with other sdl2 libraries (gfx, image, mixer, ttf), are available on the wiiu-fling pacman repository.
+Please reffer to [these](https://gitlab.com/QuarkTheAwesome/wiiu-fling) instructions to set up wiiu-fling.
+
+### Building on Linux
+In order to build sdl2 for wiiu, you'll need to install some prerequisites:
+   -  devkitPPC (make sure to export $DEVKITPRO)
+   - wut (make sure to export $WUT_ROOT)
+   - cmake
+
+Clone and enter the wiiu sdl repo:
+
+    $ git clone https://github.com/yawut/SDL.git
+    $ cd SDL
+Prepare for the build:
+
+    $ mkdir -p SDL/build
+    $ cd SDL/build
+Build:
+
+    $ cmake ../ -DCMAKE_TOOLCHAIN_FILE=$WUT_ROOT/share/wut.toolchain.cmake -DCMAKE_INSTALL_PREFIX=$DEVKITPRO/portlibs/wiiu
+    $ make
+Install (might need to run as sudo depending on `$DEVKITPRO/portlibs/wiiu`permissions):
+
+    $ make install
+
+
+### Credits:
+- rw-r-r-0644, quarktheawesome, exjam: wiiu sdl2 port and libraries
+- wiiu homebrew contributors
+- sdl mantainters
+- inspired by libnx/libtransistor sdl2 ports
+