Make it a function
[xonotic/gmqcc.git] / INSTALL
1                            Installing gmqcc
2
3 1. Prerequisites
4     - A C-Compiler such as gcc or clang
5     - GNU Make or BSD Make
6
7 2. Compilation
8     If using GNU make program
9         make
10
11     If using BSD make program, the BSDmakefile should be
12     used instead when you invoke make, if however it ignores BSDmakefile
13     you can supply it with -f.
14
15         make -f BSDmakefile
16
17     If no error appears, the following binary files will have been
18     created:
19         - gmqcc
20         - qcvm
21         - gmqpak
22
23 3. Installation
24     The `install' target will install the 2 binaries to /usr/local/bin
25     by default.
26     The Makefile honors the following variables:
27
28         - DESTDIR: The installation directory root.
29         - PREFIX:  The installation prefix, default: /usr/local
30         - BINDIR:  Directory for binary executables,
31                    deafult: $PREFIX/bin
32
33     To install to /usr/local run:
34
35         make install
36
37     To install to /usr run:
38
39         make PREFIX=/usr install
40
41     To install to a package-staging directory such as $pkgdir when
42     writing a build script file:
43
44         make DESTDIR=$pkgdir install
45
46
47     ArchLinux PKGBUILDs (release and git build) can be found in the
48     respective folders in ./distro/archlinux
49     
50     ArchBSD PKGBUILDs (release and git build) can be found in the
51     respective folders in ./distro/archbsd
52
53     Slackware SlackBuilds (git build) can be found in ./distro/slackware
54     
55     Gentoo ebuilds (release) can be found in ./distro/gentoo, as well
56     as a README explaining how to build them
57     
58     Debian archives (git build) can be created invoking make in
59     ./distro/deb
60
61     Fedora spec files (release) can be found in ./distro/fedora, as well
62     as a README explaining how to build them.