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