From 6a75feeb462c475c5da6ac3a2617397d6ac466ba Mon Sep 17 00:00:00 2001 From: BullyWiiPlaza Date: Sun, 8 Sep 2019 12:12:29 +0200 Subject: [PATCH] Clarify build instructions --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4e80a19..11f706a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,26 @@ -#### Usage +### Usage See [Homebrew_Applications](https://switchbrew.org/wiki/Homebrew_Applications) for SD layout and applications, etc. See [Switchbrew](https://switchbrew.org/wiki/Homebrew_Menu) for hbmenu docs. -#### Download +### Download The latest release is available from the [releases](https://github.com/switchbrew/nx-hbmenu/releases/latest) page. -#### Building -Build with ```make nx``` or just run ```make```. +### Building +Build for the Nintendo Switch with ```make nx``` and for the PC with ```make pc```. +Running ```make``` builds for both systems. -The following is required to build: libfreetype (switch-freetype), libconfig (switch-libconfig), and libjpeg-turbo (switch-libjpeg-turbo). Where "({name})" is the pacman package. For the pc-build libminizip is required (for the Switch build, the switch-zlib package includes this). +The following [pacman packages](https://devkitpro.org/wiki/devkitPro_pacman) are required to build: +- `switch-dev` +- `switch-freetype` +- `switch-libconfig` +- `switch-libjpeg-turbo` +- `switch-zlib` +- `zip` (on Windows) -C11-threads are used, hence building for the pc-build may fail if C11-threads are not available. +For the PC build, `libminizip` is required (for the Switch build, the `switch-zlib` package includes this). + +Since C11 threads are used, building for the PC may fail if C11 threads are not available. #### Credits * This uses code based on 3DS [new-hbmenu](https://github.com/fincs/new-hbmenu). -* libjpeg-turbo is used for handling JPEG icons. This library doesn't support lossless JPEG (likewise for official sw which uses libjpeg-turbo). +* `libjpeg-turbo` is used for handling JPEG icons. This library doesn't support lossless JPEG (likewise for official sw which uses `libjpeg-turbo`).