Document missing build options

Signed-off-by: AntonioND <antonio_nd@outlook.com>
This commit is contained in:
AntonioND
2017-03-28 19:37:10 +01:00
parent 6b21e02c95
commit dfb99618f5

View File

@@ -8,8 +8,8 @@ for the Game Boy and Game Boy Color. It consists of:
- rgbfix (checksum/header fixer) - rgbfix (checksum/header fixer)
- rgbgfx (PNGtoGame Boy graphics converter) - rgbgfx (PNGtoGame Boy graphics converter)
rgbds-linux is a fork of the original RGBDS which aims to make the programs This is a fork of the original RGBDS which aims to make the programs more like
more like other UNIX tools. other UNIX tools.
## Installing RGBDS (UNIX) ## Installing RGBDS (UNIX)
@@ -51,20 +51,27 @@ mkdir -p $HOME/{bin,man/man1,man/man7}
make install PREFIX=$HOME make install PREFIX=$HOME
``` ```
`PREFIX`: Location where RGBDS will be installed. Defaults to /usr/local. `PREFIX`: Location where RGBDS will be installed. Defaults to `/usr/local`.
`BINPREFIX`: Location where the RGBDS programs will be installed. Defaults `BINPREFIX`: Location where the RGBDS programs will be installed. Defaults
to ${PREFIX}/bin. to `${PREFIX}/bin`.
`MANPREFIX`: Location where the RGBDS man pages will be installed. Defaults `MANPREFIX`: Location where the RGBDS man pages will be installed. Defaults
to ${PREFIX}/man. to `${PREFIX}/man`.
`Q`: Whether to quiet the build or not. To make the build more verbose, clear `Q`: Whether to quiet the build or not. To make the build more verbose, clear
this variable. Defaults to @. 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 (Windows) ## Installing RGBDS (Windows)
Windows builds are available here: https://github.com/bentley/rgbds/releases Windows builds are available here: https://github.com/rednex/rgbds/releases
Copy the .exe files to C:\Windows\ or similar. Copy the .exe files to C:\Windows\ or similar.