2007-08-31 Fabian S. <[email protected]>

	* V189
	* Doxyfile.extended, Doxyfile.quick: new files for documentation
	  generation
	* AUTHORS, DEVELOPER, PLAN, QUESTIONS, README, TODO, WHO_SPOT:
	  transformed to doxygen style pages
	* Makefile.in: introduced "doc" and "extendeddoc" targets

AUTHORS

@@ -1,11 +1,16 @@
-The original  game was computer  version of  the Liftoff! board  game by
-Fritz  Bronner. It  was  developed  by  Fritz  and  Michael  McCarty  at
-Strategic Visions and published by Interplay  in as a disk based game in
-1992 and a CD-ROM in 1994.
-
-People who have contributed to the open-source version:
-
-	Michael K McCarty <[email protected]>
-	Pace Willisson <[email protected]>
-	Krzysztof Kosciuszkiewicz <[email protected]>
-  Will Glynn <[email protected]>
+/** \page authors AUTHORS
+ *	\section original Original game
+ *	The original  game was computer  version of  the Liftoff! board  game by
+ *	Fritz  Bronner. It  was  developed  by  Fritz  and  Michael  McCarty  at
+ *	Strategic Visions and published by Interplay  in as a disk based game in
+ *	1992 and a CD-ROM in 1994.
+ *	
+ *	\section The open-source version
+ *	People who have contributed to the open-source version:
+ *
+ *	\li Michael K McCarty <[email protected]>
+ *	\li Pace Willisson <[email protected]>
+ *	\li Krzysztof Kosciuszkiewicz <[email protected]>
+ *	\li Will Glynn <[email protected]>
+ *
+ */

ChangeLog

@@ -1,3 +1,15 @@
+2007-08-31  Fabian S. <[email protected]>
+
+	* V189
+
+	* Doxyfile.extended, Doxyfile.quick: new files for documentation
+	  generation
+
+	* AUTHORS, DEVELOPER, PLAN, QUESTIONS, README, TODO, WHO_SPOT:
+	  transformed to doxygen style pages
+
+	* Makefile.in: introduced "doc" and "extendeddoc" targets
+
 2007-08-31  Fabian S. <[email protected]>
 
 	* V188

DEVELOPER

@@ -1,84 +1,90 @@
-0. Dependencies:
+/** \page developers DEVELOPER NOTES
+\section dependencies 0. Dependencies:
 
-    libSDL      http://www.libsdl.org/
-    libogg      
-    libvorbis
-    libtheora   all available at http://xiph.org/downloads/
+    \li libSDL      http://www.libsdl.org/
+    \li libogg      
+    \li libvorbis
+    \li libtheora   all available at http://xiph.org/downloads/
 
-1. Building on Linux - easy
+\section buildlinux 1. Building on Linux - easy
 
-    1)  Use your favorite package manager to get development libraries, ie:
+    \note Notes: This requires autoconf, you may need to install this too.
+
+    \li 1)  Use your favorite package manager to get development libraries, ie:
         # apt-get install libsdl-dev libtheora-dev libogg-dev libvorbis-dev
-    2)  $ ./configure
-    3)  $ make
+    \li 2)  $ ./configure
+    \li 3)  $ make
 
-    Notes: I needed to do these extra things before ./configure:
+    \note Notes: I needed to do these extra things before ./configure:
 
-        # cp m4/theora.m4 /usr/share/aclocal/.
-        $ aclocal -I m4
-        $ autoconf
+        \li # cp m4/theora.m4 /usr/share/aclocal/.
+        \li $ aclocal -I m4
+        \li $ autoconf
 
-    autoconf prints one error:
+    \attention autoconf prints one error:
 
-        configure.in:51: error: possibly undefined macro: AC_TYPE_SSIZE_T
+        \li configure.in:51: error: possibly undefined macro: AC_TYPE_SSIZE_T
 
     which can be ignored
 
-2. Cross compiling: Linux - Windows: tested
+\section crosscompile 2. Cross compiling: Linux - Windows: tested
 
-    1)  install the cross compiler as described at:
+    \li 1)  install the cross compiler as described at:
         http://www.libsdl.org/extras/win32/cross/README.txt
-    2)  download SDL, development version for mingw32
-    3)  copy SDL-xxx/lib/* from this tar file into your directory
+    \li 2)  download SDL, development version for mingw32
+    \li 3)  copy SDL-xxx/lib/* from this tar file into your directory
         of choice
-    4)  download SDL runtime for win32 and put SDL.dll into
+    \li 4)  download SDL runtime for win32 and put SDL.dll into
         os_win32 directory.
-    5)  download and cross-compile required libraries, put the dlls into
+    \li 5)  download and cross-compile required libraries, put the dlls into
         os_win32 directory, static versions and C headers into directories
         you were using in step 3)
-    6)  edit os_win32/configure.mingw, run it
-    7)  make
-    8)  to build an installer you will need makensis tool, get it from
+    \li 6)  edit os_win32/configure.mingw, run it
+    \li 7)  make
+    \li 8)  to build an installer you will need makensis tool, get it from
         http://nsis.sourceforge.net/, it is also available in debian (nsis)
 
-3. Building on Mac OS X
+\section buildmac 3. Building on Mac OS X
 
-    1)  Download and install the Mac OS X version of SDL from libsdl.org
-    2)  Unpack the data and music to race-data/ in the same directory that
+    \li 1)  Download and install the Mac OS X version of SDL from libsdl.org
+    \li 2)  Unpack the data and music to race-data/ in the same directory that
         holds the race/ source tree. The data is embedded in the .app in
 		the OS X version, so it is required at build time.
-	3)  Checkout the 'xiph' module to the same place as race/ and
+	\li 3)  Checkout the 'xiph' module to the same place as race/ and
 		race-data/. Open the Xcode project, and build for both Debug and
 		Release.
-    4)  Open race/os_macosx/RaceIntoSpace.xcodeproj and compile.
+    \li 4)  Open race/os_macosx/RaceIntoSpace.xcodeproj and compile.
+
+\section buildrpm 4. Making RPM's 
 
-4. Making RPM's (THIS SECTION NEEDS UPDATING)
+\todo THIS SECTION (Making RPMs) NEEDS UPDATING
 
-    1)  useful instructions:
+    \li 1)  useful instructions:
         https://pmc.ucsc.edu/~dmk/notes/RPMs/Creating_RPMs.html
-    2)  install rpmdevtools from fedora
-    3)  run rpmdev-setuptree to make a build environment in your home
+    \li 2)  install rpmdevtools from fedora
+    \li 3)  run rpmdev-setuptree to make a build environment in your home
         directory
-    4)  create ~/.rpmmacros as:
+    \li 4)  create ~/.rpmmacros as:
         %_topdir /home/race/rpmbuild
         %_tmppath /home/race/rpmbuild/tmp
-    5)  run the script "mkrpm"
+    \li 5)  run the script "mkrpm"
 
-5. Building on Windows using mingw32
+\section buildwin 5. Building on Windows using mingw32
 
     This method was used in early testing, but may no longer work.  Give
     it  a shot  if  you like.   You will  need  development versions  of
     libraries mentioned  above. mingw32 version  of SDL is  available at
     http://libsdl.org, other ones  would probably have to  be built from
     source.
 
-    1)  cd os_win32/
-    2)  Edit file configure.mingw32
-    3)  run ./configure.mingw32
-    4)  make
+    \li 1)  cd os_win32/
+    \li 2)  Edit file configure.mingw32
+    \li 3)  run ./configure.mingw32
+    \li 4)  make
 
-6. CVS access
+\section cvs 6. CVS access
 
     You can  get the  most recent  version of  the game  using anonymous
     CVS   access. See  http://sourceforge.net/cvs/?group_id=129186   for
     instructions.
+*/