Documentation update

5 files changed, 56 insertions, 14 deletions

diff --git a/Doxyfile b/Doxyfile
index 38e6939..3a86532 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -3,9 +3,9 @@
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
-PROJECT_NAME           = osirion.kdevelop
+PROJECT_NAME           = "The Osirion Project"
 PROJECT_NUMBER         = 0.0.1
-OUTPUT_DIRECTORY       = 
+OUTPUT_DIRECTORY       = doc
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 USE_WINDOWS_ENCODING   = YES
@@ -82,7 +82,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = /home/ingar/projects/osirion
+INPUT                  = src/
 FILE_PATTERNS          = *.c \
                          *.cc \
                          *.cxx \
@@ -132,7 +132,7 @@ FILE_PATTERNS          = *.c \
                          *.moc \
                          *.xpm \
                          *.dox
-RECURSIVE              = yes
+RECURSIVE              = YES
 EXCLUDE                = 
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = 
@@ -214,7 +214,7 @@ MAN_LINKS              = NO
 #---------------------------------------------------------------------------
 # configuration options related to the XML output
 #---------------------------------------------------------------------------
-GENERATE_XML           = yes
+GENERATE_XML           = NO
 XML_OUTPUT             = xml
 XML_SCHEMA             = 
 XML_DTD                = 
diff --git a/INSTALL b/INSTALL
index 3288f2f..f6aeb8e 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,9 +1,28 @@
 Basic Installation
 ==================
 
-To build the source you will need the SDL and OpenGL library and header files.
+To build the Osirion Project from source you will need 
+the SDL and OpenGL library and header files.
 
+In theory, it should compile on any platform supported by SDL.
+I have succesfully compiled it on the following platforms:
+	linux-x86_64, gcc 4.1.2, SDL 1.2.11 
+	mingw-win32
+
+Compile the source by executing the following commands:
+
+autoreconf -fi
 ./configure
 make
+
+To run the program execute:
+
 src/client/osirion
 
+To run the dedicated server:
+src/server/osiriond
+
+The game data files should be located in the subdirectory
+data/base if the main distribution.
+
+
diff --git a/README b/README
index db98823..91c490a 100644
--- a/README
+++ b/README
@@ -1,17 +1,32 @@
-The Osirion Project
 
-This is the Osirion project. I wrote it to get a better grasp on OpenGL
-and to get some C++ practice. Maybe someday, it will be a real game.
+Project::OSiRiON
+
+	This is the Osirion project. I wrote it to get a better grasp on OpenGL
+	and to get some C++ practice. Maybe someday, it will be a real game.
+
+Controls
 
-Controls:
 	space bar: switch camera between free mode and tracking mode
-	left/right/up/down arrow keys:	rotate camera in free mode
+	left/right/up/down arrow keys: rotate camera in free mode
 	keypad left/right: turn the ship left/right
 	keypad +/-: increase/decrease thrust
 	
-The program is distributed under the terms and conditions of the 
-GNU General Public License version 2.
+Organization of the distribution
 
+	src/		C++ source code
 
-Stijn Buys <stijn.buys@telenet.be>
+		client\		osirion client
+		common\		General utility classes
+		game\		Game engine, used by client and server
+		gl\		OpenGL library, used by client
+		server\		osiriond dedicated server
 
+	data/		Data files
+		base\		main data files
+		
+License
+	The program is distributed under the terms and conditions of the 
+	GNU General Public License version 2.
+
+
+Stijn Buys <stijn.buys@telenet.be>
diff --git a/ROADMAP b/ROADMAP
new file mode 100644
index 0000000..9af4cbd
--- /dev/null
+++ b/ROADMAP
@@ -0,0 +1,4 @@
+
+M1: Multiple ships, one ship controlled by the player
+
+
diff --git a/TODO b/TODO
index e69de29..0f09bb0 100644
--- a/TODO
+++ b/TODO
@@ -0,0 +1,4 @@
+
+* Fix win32 issues
+	server/timer.h
+	server/tmer.cc
\ No newline at end of file