From 884667848ecf043dd2d8c5421250c88931151bd1 Mon Sep 17 00:00:00 2001
From: Stijn Buys <ingar@osirion.org>
Date: Wed, 6 Feb 2008 20:05:10 +0000
Subject: Documentation updates

---
 README | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 51 insertions(+), 10 deletions(-)

(limited to 'README')

diff --git a/README b/README
index 0b6a919..764118b 100644
--- a/README
+++ b/README
@@ -1,34 +1,75 @@
 
-Project::OSiRiON
+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.
+	This is the Osirion project. I wrote it to get a better grasp on
+	game design with opengl and to get some C++ practice. 
+	Maybe someday, it will be a real game.
 
-	Read INSTALL for Installation instructions.
+	Read INSTALL for instructions on building and installation.
+
+Dedicated server
+
+	The dedicated server can be started, but it does not yet
+	support network connections or local input.
+
+Client
+
+	Starting the client will show the loader screen.
+	To start the game, open the client console and type 'connect'.
+	Type 'disconnect' to return to the loader screen.
 
 Controls
 
-	space bar: switch camera between free mode and tracking mode
+	~: toggle client console visibility
+	space bar: switch camera mode
 	left/right/up/down arrow keys: rotate camera in free mode
 	keypad left/right: turn the ship left/right
 	keypad +/-: increase/decrease thrust
 	
+Console functions
+
+	The following commands are available on the console:
+
+		connect		connect the client to the game module
+		disconnect	disconnect the client from the game module
+		list_func	lists registered functions
+		list_var	lists registered variables
+		quit		exit the application
+		r_restart	restart the video subsystem
+
+	To change the video resolution, set the r_width and 
+	r_height variables and execute r_restart.
+	e.g.: to set the video mode to 1024x768 type:
+		
+		r_width 1024
+		r_height 768
+		r_restart
+
+	To switch to windowed mode, set the r_fullscreen 
+	variable to 0:
+
+		r_fullscreen 0
+		r_restart
+	
 Organization of the distribution
 
 	src/		C++ source code
 
 		math\		mathematical classes
 		sys\		low-level system functions
-		filesystem\	virtual filesystem
-		core\		game-independent core classes
+		filesystem\	virtual filesystem library
+		core\		game-independent core library
 		game\		game-specific functions 
 		server\		osiriond dedicated server
-		gl\		OpenGL wrapper library
+		render\		render library
 		client\		osirion client
 
 	data/		Data files
-		base\		main data files
-		
+		base\		base data files
+	
+	The game data can be obtained as a seperate distribution.
+	Refer to the file INSTALLATION for more information.
+
 License
 
 	The program is distributed under the terms and conditions of the 
-- 
cgit v1.2.3