Convert and link INSTALL into our doxygen docs.

INSTALL

@@ -1,72 +1,98 @@
-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.
+//This file is formatted for processing with doxygen.
+//unfortunatly, have to wrap the docs in a C comment for doxygen
+/**
+\page build-install Building and Installing 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.
+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.
 
-UNIX users: because of the diversity of machines QuakeForge runs on, we do not provide UNIX binaries. You need to compile QuakeForge yourself, however QuakeForge is very easy to compile once you have the following packages installed:
+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.
 
-    * GNU autoconf 2.50 or later
+\note UNIX users: because of the diversity of machines on which QuakeForge
-    * GNU automake 1.6 or later
+runs , we do not provide UNIX binaries. You need to compile QuakeForge
-    * GNU libtool 1.4 or later
+yourself, however QuakeForge is very easy to compile once you have the
-    * GNU bison
+necessary packages installed.
-    * GNU flex
+
-    * GNU make (BSD make doesn't like some constructs used)
+\section req-pack Required Packages
-    * C compiler and preprocessor (gcc and cpp recommended)
+The following packages are required to build QuakeForge:
-    * libsamplerate
+\li GNU autoconf 2.50 or later
+\li GNU automake 1.6 or later
+\li GNU libtool 1.4 or later
+\li GNU bison
+\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:
-    * git (highly recommended for staying up to date with current changes)
+\li git (highly recommended for staying up to date with current changes)
-    * zlib devel (highly recommended for compressed file and download support)
+\li zlib devel (highly recommended for compressed file and download support)
-    * Ogg Vorbis libs (for compressed sound effects support)
+\li curl (for http download support (\ref qw_download_spec))
-    * X11 devel (for X11-based clients: software and OpenGL)
+\li Ogg Vorbis libs (for compressed sound effects support)
-    * glide and mesa or other GL compatible lib
+\li X11 devel (for X11-based clients: software and OpenGL)
-    * svgalib (for console-based clients: software and 3dfx)
+\li glide and mesa or other GL compatible lib
+\li svgalib (for console-based clients: software and 3dfx)
 
-Relevant packages (debian):
+\section package-names Relevant Package Names
-    * build-essential
+The following is the list of relevant package names in debian.
-    * autoconf
+\li build-essential
-    * automake
+\li autoconf
-    * libtool
+\li automake
-    * flex
+\li libtool
-    * bison
+\li flex
-    * git
+\li bison
+\li git
 
-    * libasound2-dev
+\li libasound2-dev
-    * libjack-dev
+\li libjack-dev
 
-    * libsamplerate0-dev
+\li libsamplerate0-dev
 
-    * libflac-dev
+\li libflac-dev
-    * libogg-dev
+\li libogg-dev
-    * libvorbis-dev
+\li libvorbis-dev
-    * libpng12-dev
+\li libpng12-dev
-    * zlib1g-dev
+\li zlib1g-dev
 
-    * libcurl4-openssl-dev (or libcurl4-gnutls-dev)
+\li libcurl4-openssl-dev (or libcurl4-gnutls-dev)
-    * libncurses5-dev
+\li libncurses5-dev
-
-    * libsdl1.2-dev
-    * libsvga1-dev
-    * libxxf86dga-dev
-    * libxxf86vm-dev
 
+\li libsdl1.2-dev
+\li libsvga1-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 `./configure --help` and select options.
+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 and mscgen are required), in an
 already configured source tree:
+\verbatim
 	cd doc
 	make doc
+\endverbatim
 
-Then either point your webbrowser to doxygen/html/index.html, or copy/move
+Then either point your webbrowser to <code>doxygen/html/index.html</code>, or
-doxygen/html to a webserver and point your browser to that. The
+copy/move <code>doxygen/html</code> to a webserver and point your browser
-documentation is currently grossly inadequate, but hopefully it is of some
+to that. The documentation is currently grossly inadequate, but hopefully
-help.
+it is of some help.
+*/

doc/Makefile.am

@@ -1,12 +1,18 @@
 AUTOMAKE_OPTIONS= foreign
 
 SUBDIRS= man
+
+TXT_DOCS=\
+	bind.txt connect.txt cshifts.txt dirconf.txt faq.txt \
+	filesystem.txt mapformat.txt qtv.txt quakeforge.txt qw-cap-spec.txt \
+	qw-download-spec.txt surround-sound.txt timestamps.txt
+
 EXTRA_DIST= qf.ico \
 	\
-	skybox.fig template.c template.h timestamps.txt \
+	skybox.fig template.c template.h \
 	quakeforge.dox.in \
 	\
-	faq.txt quakeforge.txt \
+	${TXT_DOCS} \
 	\
 	config/glspeed-v1.cfg config/glspeed-v3.cfg config/swspeed.cfg \
 	\
@@ -33,5 +39,5 @@ progs/vm-mem.eps: progs/vm-mem.fig
 qtv/qwtv.png: qtv/qwtv.fig
 qtv/qwtv.eps: qtv/qwtv.fig
 
-doc: quakeforge.dox progs/vm-mem.png progs/vm-mem.eps qtv/qwtv.png qtv/qwtv.eps
+doc: quakeforge.dox progs/vm-mem.png progs/vm-mem.eps qtv/qwtv.png qtv/qwtv.eps ${TXT_DOCS}
 	doxygen quakeforge.dox

doc/quakeforge.dox.in

@@ -588,6 +588,7 @@ INPUT                 += @TOPSRC@/qtv
 INPUT                 += @TOPSRC@/qw
 INPUT                 += @TOPSRC@/tools
 INPUT                 += @TOPSRC@/doc/bind.txt
+INPUT                 += @TOPSRC@/INSTALL
 INPUT                 += @TOPSRC@/doc/connect.txt
 INPUT                 += @TOPSRC@/doc/cshifts.txt
 INPUT                 += @TOPSRC@/doc/dirconf.txt

doc/quakeforge.txt

@@ -8,6 +8,7 @@ Quake and QuakeWorld game engine.  Our purpose?  To improve the state of the
 game by improving the engine and making it accessable to the largest number
 of players we can.
 
+\li \subpage build-install
 \li \subpage faq
 \li \subpage key_binding
 \li \subpage cshift_cvars