From b31632b51d3dd526ab8612a963030168d4fe4c19 Mon Sep 17 00:00:00 2001 From: Ben10do Date: Sun, 2 Apr 2017 17:57:51 +0100 Subject: [PATCH] =?UTF-8?q?Update=20the=20README=E2=80=99s=20Mac-specific?= =?UTF-8?q?=20instructions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Rename the “Installing RGBDS (UNIX)” section to “Building RGBDS”, as that’s what we’re doing, regardless of platform. - Update references of Mac OS X to macOS. - State that only libpng and pkg-config need to be downloaded with Homebrew; the others are pre-installed along with Xcode. - State that RGBDS itself is available through Homebrew. --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9c7037e4..4a7fc21a 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,18 @@ This is a fork of the original RGBDS which aims to make the programs more like other UNIX tools. -## Installing RGBDS (UNIX) +## Building RGBDS RGBDS requires yacc, flex, libpng and pkg-config to be installed. -On Mac OS X, install them with [Homebrew](http://brew.sh/). On other Unixes, -use the built-in package manager. For example, on Debian or Ubuntu: +On macOS, install the latter two with [Homebrew](http://brew.sh/): + +```sh +brew install libpng pkg-config +``` + +On other Unixes, use the built-in package manager. For example, on Debian or +Ubuntu: ```sh sudo apt-get install byacc flex pkg-config libpng-dev @@ -74,6 +80,22 @@ Defaults to `-s`. `MANMODE`: Permissions of the installed manpages. Defaults to `444`. +## Installing RGBDS (macOS) + +If you would prefer not to build RGBDS yourself, you may also install it using +[Homebrew](http://brew.sh/). To install the latest release, use: + +```sh +brew install rgbds +``` + +To install RGBDS with all of the current changes in development (as seen on +GitHub), use: +```sh +brew install rgbds --HEAD +``` + + ## Installing RGBDS (Windows) Windows builds are available here: https://github.com/rednex/rgbds/releases