shithub: rgbds

Info  •  Files  •  Log  •  Branches

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.

--- a/README.md

+++ b/README.md

@@ -12,14 +12,20 @@

 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

 ```

@@ -72,6 +78,22 @@

 `BINMODE`: Permissions of the installed binaries. Defaults to `555`.

 `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)