Update install file
[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 use Makefile.bsd instead
12         make -f Makefile.bsd
13
14
15     If no error appears, the following binary files will have been
16     created:
17         - gmqcc
18         - qcvm
19         - pak
20
21 3. Installation
22     The `install' target will install the 2 binaries to /usr/local/bin
23     by default.
24     The Makefile honors the following variables:
25
26         - DESTDIR: The installation directory root.
27         - PREFIX:  The installation prefix, default: /usr/local
28         - BINDIR:  Directory for binary executables,
29                    deafult: $PREFIX/bin
30
31     To install to /usr/local run:
32
33         make install
34
35     To install to /usr run:
36
37         make PREFIX=/usr install
38
39     To install to a package-staging directory such as $pkgdir when
40     writing a build script file:
41
42         make DESTDIR=$pkgdir install
43
44
45     ArchLinux PKGBUILDs (release and git build) can be found in the
46     respective folders in ./distro/archlinux
47     
48     ArchBSD PKGBUILDs (release and git build) can be found in the
49     respective folders in ./distro/archbsd
50
51     Slackware SlackBuilds (git build) can be found in ./distro/slackware
52     
53     Gentoo ebuilds (release) can be found in ./distro/gentoo, as well
54     as a README explaining how to build them
55     
56     Debian archives (git build) can be created invoking make in
57     ./distro/deb