diff --git a/README.md b/README.md index 88fd9f4..172ff1e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Vanilla -This is a **work-in-progress** software clone of the Wii U gamepad for Linux (including Raspberry Pi and Steam Deck) and Android. No warranty is provided and everything should be considered **alpha** at best. +This is a **work-in-progress** software clone of the Wii U gamepad. No warranty is provided and everything should be considered **alpha** at best.

@@ -10,6 +10,18 @@ This is a **work-in-progress** software clone of the Wii U gamepad for Linux (in

+## Usage/Installing + +Official builds are provided for all supported platforms on the [Releases](https://github.com/vanilla-wiiu/vanilla/releases) page. Most users are recommended to use these. + +### Distro-specific packages + +Vanilla is also available in the package managers of certain Linux distributions. + +#### Arch (AUR) + +An Arch User Repository (AUR) package called `vanilla-wiiu-git` is available for easy installation on Arch Linux and derivatives. For more information, see the AUR page: [https://aur.archlinux.org/packages/vanilla-wiiu-git](https://aur.archlinux.org/packages/vanilla-wiiu-git) + ## What devices are supported? - [Steam Deck](https://github.com/vanilla-wiiu/vanilla/wiki/Steam-Deck) @@ -29,19 +41,19 @@ In practice, not all hardware/drivers appear to work at this time. Check the [Wi ## Compiling (Linux) Vanilla currently requires the following dependencies: -- Debian/Ubuntu +- **Debian/Ubuntu** ```sh apt install build-essential cmake libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libavformat-dev libavcodec-dev libavutil-dev libswscale-dev libnl-genl-3-dev libnl-route-3-dev libssl-dev libxml2-dev libnm-dev ``` -- Fedora +- **Fedora** ```sh dnf install libavcodec-free-devel libavutil-free-devel libavfilter-free-devel libnl3-devel SDL2-devel SDL2_image-devel SDL2_ttf-devel openssl-devel make automake gcc gcc-c++ kernel-devel cmake libxml2-devel NetworkManager-libnm-devel ``` -- Arch +- **Arch** ```sh - pacman -S base-devel make cmake ffmpeg libnl sdl2 sdl2_image sdl2_ttf libxml2 libnm + pacman -S base-devel make cmake ffmpeg libnl sdl2 sdl2_image sdl2_ttf libxml2 libnm openssl ``` -- Alpine/postmarketOS +- **Alpine/postmarketOS** ```sh apk add build-base cmake sdl2-dev sdl2_image-dev sdl2_ttf-dev ffmpeg-dev libnl3-dev libxml2-dev openssl-dev networkmanager-dev ```