mirror of
https://git.code.sf.net/p/quake/quakeforge
synced 2024-11-27 06:34:11 +00:00
00639aa9d1
It turns out the apiprefix define is quite new (I didn't realize it at the time) and I'd rather get FTBFS reports based on configure catching the error than gcc catching it.
109 lines
3.1 KiB
Text
109 lines
3.1 KiB
Text
//This file is formatted for processing with doxygen.
|
|
//unfortunatly, have to wrap the docs in a C comment for doxygen
|
|
// vim:tw=74:formatoptions-=l
|
|
/**
|
|
\page build-install Building and Installing QuakeForge
|
|
|
|
This is our new development tree (we're back to "quakeforge"), where we're
|
|
again in the process of merging Quake and QuakeWorld ... but this time,
|
|
it's much better. :), and will eventually provide the 0.6 versions of
|
|
QuakeForge.
|
|
|
|
While almost always in working order, it's under heavy development so be
|
|
prepared to encounter some issues (Wear your hard hat!). Please check the
|
|
docs.
|
|
|
|
\note UNIX users: because of the diversity of machines on which QuakeForge
|
|
runs , we do not provide UNIX binaries. You need to compile QuakeForge
|
|
yourself, however QuakeForge is very easy to compile once you have the
|
|
necessary packages installed.
|
|
|
|
\section req-pack Required Packages
|
|
The following packages are required to build QuakeForge:
|
|
\li GNU autoconf 2.50 or later
|
|
\li GNU automake 1.6 or later
|
|
\li GNU libtool 1.4 or later
|
|
\li GNU bison 2.6 or later
|
|
\li GNU flex
|
|
\li GNU make (BSD make doesn't like some constructs used)
|
|
\li C compiler and preprocessor (gcc and cpp recommended)
|
|
\li libsamplerate
|
|
|
|
\section rec-pack Recommended Packages
|
|
The following are recommended:
|
|
\li git (highly recommended for staying up to date with current changes)
|
|
\li zlib devel (highly recommended for compressed file and download support)
|
|
\li curl (for http download support (\ref qw_download_spec))
|
|
\li Ogg Vorbis libs (for compressed sound effects support)
|
|
\li X11 devel (for X11-based clients: software and OpenGL)
|
|
\li glide and mesa or other GL compatible lib
|
|
\li svgalib (for console-based clients: software and 3dfx)
|
|
|
|
\section package-names Relevant Package Names
|
|
The following is the list of relevant package names in debian.
|
|
\li build-essential
|
|
\li autoconf
|
|
\li automake
|
|
\li libtool
|
|
\li flex
|
|
\li bison
|
|
\li git
|
|
|
|
\li libasound2-dev
|
|
\li libjack-dev
|
|
|
|
\li libsamplerate0-dev
|
|
|
|
\li libflac-dev
|
|
\li libogg-dev
|
|
\li libvorbis-dev
|
|
\li libpng12-dev
|
|
\li zlib1g-dev
|
|
|
|
\li libcurl4-openssl-dev (or libcurl4-gnutls-dev)
|
|
\li libncurses5-dev
|
|
|
|
\li libsdl1.2-dev
|
|
\li libsvga1-dev
|
|
\li libxext-dev
|
|
\li libxxf86dga-dev
|
|
\li libxxf86vm-dev
|
|
|
|
\section building-and-installing Build and Install Procedure
|
|
Basic process to build and install QuakeForge:
|
|
\verbatim
|
|
./bootstrap
|
|
./configure
|
|
make install
|
|
\endverbatim
|
|
|
|
You may want to check <code>./configure --help</code> and select options.
|
|
|
|
To build and install only the quakeworld server:
|
|
\verbatim
|
|
./bootstrap
|
|
./configure --without-clients --without-tools --with-servers=qw
|
|
make install
|
|
\endverbatim
|
|
|
|
To build documentation (doxygen, graphviz, mscgen and transfig are required),
|
|
in an already configured source tree:
|
|
\verbatim
|
|
cd doc
|
|
make doc
|
|
\endverbatim
|
|
|
|
If the tree has not been configured and doing so is not desirable or
|
|
possible, then the documentation may be configured separately:
|
|
\verbatim
|
|
cd doc
|
|
./docstrap
|
|
./configure
|
|
make doc
|
|
\endverbatim
|
|
|
|
Then either point your webbrowser to <code>doxygen/html/index.html</code>, or
|
|
copy/move <code>doxygen/html</code> to a webserver and point your browser
|
|
to that. The documentation is currently grossly inadequate, but hopefully
|
|
it is of some help.
|
|
*/
|