diff --git a/README.md b/README.md index 4a7fc21a..8f471dd0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,50 @@ This is a fork of the original RGBDS which aims to make the programs more like other UNIX tools. -## Building RGBDS +## 1. Installing RGBDS + +### 1.1 Windows + +Windows builds are available in the releases page on GitHub: + + https://github.com/rednex/rgbds/releases + +Copy the `.exe` files to `C:\Windows\` or similar. + +If you require the latest version in development, it should be possible to +compile RGBDS with MinGW or Cygwin by following the instructions to build it +on UNIX systems. + +### 1.2 Mac OS + +You can build RGBDS by following the instructions below. However, 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 the +`master` branch on GitHub), use: + +```sh +brew install rgbds --HEAD +``` + +### 1.3 Other UNIX-like systems + +No official binaries of RGBDS are distributed for these systems, you must follow +the simple instructions below to compile and install it. + + +## 2. Building RGBDS from source + +RGBDS can be built in UNIX-like systems by following the instructions below. + +### 2.1 Dependencies RGBDS requires yacc, flex, libpng and pkg-config to be installed. @@ -33,71 +76,60 @@ You can test if libpng and pkg-config are installed by running `pkg-config --cflags libpng`: if the output is a path, then you're good, and if it outputs an error then you need to install them via a package manager. -To build the programs on a UNIX or UNIX-like system, just run in your terminal: +### 2.2 Build process + +To build the programs, run in your terminal: ```sh make ``` -Then to install the compiled programs and manual pages, run (with appropriate -privileges): +Then, to install the compiled programs and manual pages, run (with appropriate +privileges, e.g, with `sudo`): + ```sh make install ``` -After installation, you can read the manuals with the man(1) command. E.g., +After installation, you can read the manuals with the `man` command. E.g., ```sh -man 1 rgbasm +man 7 rgbds ``` -Note: the variables described below can affect installation behavior when given -on the make command line. For example, to install rgbds in your home directory -instead of systemwide, run the following: +There are some variables in the Makefile that can be redefined by the user. The +variables described below can affect installation behavior when given on the +make command line. For example, to install RGBDS in your home directory instead +of systemwide, run the following: ```sh mkdir -p $HOME/{bin,man/man1,man/man7} make install PREFIX=$HOME ``` -`PREFIX`: Location where RGBDS will be installed. Defaults to `/usr/local`. - -`BINPREFIX`: Location where the RGBDS programs will be installed. Defaults -to `${PREFIX}/bin`. - -`MANPREFIX`: Location where the RGBDS man pages will be installed. Defaults -to `${PREFIX}/man`. - -`Q`: Whether to quiet the build or not. To make the build more verbose, clear -this variable. Defaults to `@`. - -`STRIP`: Whether to strip the installed binaries of debug symbols or not. -Defaults to `-s`. - -`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: +To do a verbose build, run: ```sh -brew install rgbds +make Q= ``` -To install RGBDS with all of the current changes in development (as seen on -GitHub), use: -```sh -brew install rgbds --HEAD -``` +This is the complete list of user-defined variables: +- `PREFIX`: Location where RGBDS will be installed. Defaults to `/usr/local`. -## Installing RGBDS (Windows) +- `BINPREFIX`: Location where the RGBDS programs will be installed. Defaults to + `${PREFIX}/bin`. -Windows builds are available here: https://github.com/rednex/rgbds/releases +- `MANPREFIX`: Location where the RGBDS man pages will be installed. Defaults to + `${PREFIX}/man`. -Copy the .exe files to C:\Windows\ or similar. +- `Q`: Whether to quiet the build or not. To make the build more verbose, clear + this variable. Defaults to `@`. + +- `STRIP`: Whether to strip the installed binaries of debug symbols or not. + Defaults to `-s`. + +- `BINMODE`: Permissions of the installed binaries. Defaults to `555`. + +- `MANMODE`: Permissions of the installed manpages. Defaults to `444`.