Update the README’s Mac-specific instructions

- 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.
This commit is contained in:
Ben10do
2017-04-02 17:57:51 +01:00
parent 53842cd07d
commit b31632b51d

View File

@@ -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