major documentation update

author: Stijn Buys <ingar@osirion.org> 2009-02-23 18:31:03 +0000
committer: Stijn Buys <ingar@osirion.org> 2009-02-23 18:31:03 +0000
commit: 634b12e329b0e1e305490c6bc87ce414fd027add (patch)
tree: d978be6f96719e92cf89c743854a621a3c169263 /doc/installation.html
parent: 1a4ae6ca5cd3aac0fd639c554e824525d98676ea (diff)
1 files changed, 189 insertions, 123 deletions
diff --git a/doc/installation.html b/doc/installation.html
index 10ae6c5..7da1b59 100644
--- a/doc/installation.html
+++ b/doc/installation.html
@@ -1,40 +1,50 @@
- 
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
 	<meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
-	<link rel="stylesheet" type="text/css" href="style.css">
-	<TITLE>The Osirion Project - Installation</TITLE>
+	<link rel="stylesheet" type="text/css" href="main.css">
+	<TITLE>Project::OSiRiON - Installation Instructions</TITLE>
 </head>
+
 <body>
+<div class="banner">
+	<img src="images/banner.png" ALT="Project::OSiRiON">
+	<br>
+	Installation Instructions
+</div>
 
-<h1>
-	The Osirion Project - Installation
-</h1>
+<div class="text">
 <p>
-	These are the installation instructions for the Osirion Project.
 	There are two ways to install the program and the game data. You can
-	either download a precompiled package from the website, or you
+	either download a package from the website, or you
 	can obtain the source code and compile it yourself.
 <ul>
-	<li><a href="#precompiled">Using precompiled executables</a>
+	<li><a href="#packages">Using packages</a>
 	<li><a href="#building_from_source">Building from source code</a>
 	<li><a href="#gtkradiant">GtkRadiant 1.5.0 support files (optional)</a>
 	<li><a href="#source_data">Source data (optional)</a>
 </ul>
-<h2 id="precompiled">
-	Using precompiled executables
-</h2>
-<p>
-	You can find the latest version in the download section of the website:<br>
-	<a href="http://ingar.satgnu.net/osirion/files">http://ingar.satgnu.net/osirion/files</a>
-<h3>
+</div>
+
+<div id="packages" class="title">
+	Using packages
+</div>
+<div class="text">
+<p>
+	You can find the latest version in the downloads section of the website:<br>
+	<a href="http://ingar.satgnu.net/osirion/index.html#downloads">http://ingar.satgnu.net/osirion</a>
+</p>
+</div>
+
+<div class="subtitle">
 	Windows
-</h3>
+</div>
+
+<div class="text">
 <p>
-	Download the windows executables package:<br>
+	Download the windows package:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-win32-latest.zip">osirion-win32-latest.zip</a><br>
-	This packages contains the win32 version of the server and the client.
+	This package contains the win32 version of the server and the client.
 <p>
 	Dowload the game data package:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-data-latest.zip">osirion-data-latest.zip</a><br>
@@ -45,52 +55,68 @@
 	game data.
 <p>
 	Open the game directory in explorer and click on <i>osirion.exe</i> to start the client.
-<h3>
+</div>
+
+<div class="subtitle">
 	Linux
-</h3>
+</div>
+
+<div class="text">
+
 <p>
-	Download the linux executables packages:<br>
+	Download the linux packages:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-linux-latest.zip">osirion-linux-latest.zip</a><br>
-	This packages contains the linux x86 and x86_64 versions of the client and the server.
+	This package contains the linux 32 and 64 bit versions of the client and the server.
 <p>
 	Extract the package, a new subdirectory will be created. The actual directory name will depend on
 	the version number. Enter the new subdirectory.
-<pre>
-tar jxvf osirion-latest.tar.bz2
+<div class="code">
+tar jxvf osirion-latest.tar.bz2<br>
 cd osirion-0.1_258-linux
-</pre>
+</div>
 <p>
 	Dowload the game data package:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-data-latest.zip">osirion-data-latest.zip</a><br>
 <p>
 	Unzip it:
-<pre>
+<div class="code">
 unzip ../osirion-data-latest.zip
-</pre>
+</div>
 <p>
-	 To run the 32bit client:
-<pre>
+	 To run the 32 bit client:
+<div class="code">
 ./osirion.x86
-</pre>
+</div>
 <p>
-	 To run the 64bit client:
-<pre>
+	 To run the 64 bit client:
+<div class="code">
 ./osirion.x86_64
-</pre>
-<h2 id="building_from_source">
+</div>
+
+</div>
+
+<div id="building_from_source" class="title">
 	Building from source code
-</h2>
-<h3>
-	Requirements
-</h3>
+</div>
+
+<div class="text">
 <p>
 	To build The Osirion Project from source code you will need to have
-	the following libraries and their header files installed on your system.
+	the following libraries and development packages installed on your system.
+</p>
+</div>
+<div class="subtitle">
+      Requirements
+</div>
+
+<div class="text">
 <p>
+
 	To build the client or the dedicated server:
 	<ul>
 		<li>zlib
 	</ul>
+</p>
 <p>
 	To build the client:
 	<ul>
@@ -101,131 +127,159 @@ unzip ../osirion-data-latest.zip
 		<li><A href="http://connect.creativelabs.com/openal/Downloads/Forms/AllItems.aspx">OpenAL</a>
 				or <a href="http://kcat.strangesoft.net/openal.html">OpenAL Soft</a>
 	</ul>
+</p>
 <p>
 	You will also need a recent version of gcc, GNU make, automake and libtool.
-<p>
 	In theory, the source should compile on any POSIX-compatible platform 
-	supported by SDL, reports for other platforms (working or not)
-	are welcome. I have succesfully compiled it myself on the following platforms:
-	<ul>
-		<li>linux-x86_64, gcc 4.3.1 (Arch Linux)
-		<li>linux-x86_64, gcc 4.1.2
-		<li>linux-i686, gcc 4.3.1 (Arch Linux)
-		<li>linux-i686, gcc 4.1.2
-		<li>mingw32, gcc 4.2.2
-	</ul>
-<h3>
-	Obtaining the source code
-</h3>
+	supported by SDL.
+</p>
+</div>
+
+<div class="subtitle">
+      Obtaining the source code
+</div>
+<div class="text">
 <p>
 	You can get the osirion project source code from the subversion repository:<br>
 	<a href="svn://intranifty.no-ip.org/osirion">svn://intranifty.no-ip.org/osirion</a>
+</p>
 <p>
 	On linux, you can use the Subversion command line client tool. The following 
 	command will create a new subdirectory <i>osirion</i> and download the source code into it.
-<pre>
+</p>
+<div class="code">
 svn co svn://intranifty.no-ip.org/osirion osirion
-</pre>
+</div>
 <p>
 	On windows, you can use the Turtoisesvn SubVersion client to access the
 	SVN repositories. You can download it here:<br>
-	<a href="http://tortoisesvn.tigris.org/">http://tortoisesvn.tigris.org/</a>
+	<a href="http://tortoisesvn.tigris.org">http://tortoisesvn.tigris.org</a>
+</p>
 <p>
-	You can also get the source package from the website:<br>
+	You can also download the source package from the website:<br>
 	<a href="http://ingar.satgnu.net/osirion/files/osirion-src-latest.tar.bz2">osirion-src-latest.tar.bz2</a>
-<h3>
-	Compiling the source code
-</h3>
+</p>
+</div>
+
+<div class="subtitle">
+      Compiling the source code
+</div>
+<div class="text">
 <p>
 	Enter the new directory and configure the source code:
-<pre>
-cd osirion
-autoreconf -fi
-./configure
-</pre>
+<div class="code">
+cd osirion<br>
+autoreconf -fi<br>
+./configure<br>
+</div>
+
 <p>
 	If you do not need the client and want to build the dedicated server only
 	you can pass the <i>--without-client</i> option to <i>configure</i>:
-<pre>
+</p>
+<div class="code">
 ./configure --without-client
-</pre>
+</div>
 <p>
-	If <i>configure</i> finds the ncurses library, the server will be build
-	with an ncurses console. To disable ncurses detection, pass the
-	<i>--without-ncurses</i> option to <i>configure</i>.
+	If <i>configure</i> finds ncurses or pdcurses, the dedicated server will use this
+	library and a have a curses console. To disable curses detection, pass the
+	<i>--without-curses</i> option to <i>configure</i>.
+</p>
 <p>
 	<b>Important</b>: <i>make install</i> is not supported. Results are unpredictable.
+</p>
 <p>
 	Compile the source code:
-<pre>
+</p>
+<div class="code">
 make
-</pre>
+</div>
 <p>
 	The binaries will be build in the <i>src</i> subdirectory of the main distribution.
-<h3>
-	Obtaining the game data 
-</h3>
+</p>
+</div>
+
+<div class="subtitle">
+      Obtaining the game data 
+</div>
+<div class="text">
 <p>
 	The game data should be located in the <i>data</i> subdirectory of the main distribution.
 	You can use the game data package from the website or get it from the osirion-data subversion repository:<br>
 	<a href="svn://intranifty.no-ip.org/osirion-data">svn://intranifty.no-ip.org/osirion-data</a>
+</p>
 <p>
 	Run the following command from within the main distribution directory to download
 	the game data into the <i>data</i> subdirectory:
-<pre>
+</p>
+<div class="code">
 svn checkout svn://intranifty.no-ip.org/osirion-data data
-</pre>
-</body>
-<h3>
-	Executing
-</h3>
+</div>
+
+</div>
+
+<div class="subtitle">
+      Executing
+</div>
+<div class="text">
 <p>
-	The client and the dedicated server look for the game data in the <i>data</i> subdirectory 
+	The client and the dedicated server will look for game data in the <i>data</i> subdirectory 
 	of the current working directory. Since the binaries are build in the <i>src</i> you will
 	have to copy them with the <i>src/</i> prefix.
+</p>
 <p>
-	To start the client
-<pre>
+	To start the client:
+</p>
+<div class="code">
 src/osirion
-</pre>
+</div>
 <p>
-	To start the dedicated server
-<pre>
+	To start the dedicated server:
+</p>
+<div class="code">
 src/osiriond
-</pre>
+</div>
 <p>
-	Of you are using windows, the binaries will be called <i>osirion.exe</i> and <i>osiriond.exe</i>.
-<h3>
+	If you are using windows, the binaries will be called <i>osirion.exe</i> and <i>osiriond.exe</i>.
+</p>
+</div>
+
+<div class="subtitle">
 	Updating
-</h3>
+</div>
+<div class="text">
 <p>
 	If you downloaded and compiled the game and the game data fomr the subversion repository,
 	there is no need to re-download the entire distribution when there are updates available.
 	You can update your local copy and rebuild it.
 <p>
 	Update the source code:
-<pre>
-cd osirion
-make clean
+<div class="code">
+cd osirion<br>
+make clean<br>
 svn update
-</pre>
+</div>
 <p>
 	Update the game data:
-<pre>
-cd data
-svn update
+</p>
+<div class="code">
+cd data<br>
+svn update<br>
 cd ..
-</pre>
+</div>
 <p>
 	Rebuild the binaries:
-<pre>
-autoreconf
-./configure
+<div class="code">
+autoreconf<br>
+./configure<br>
 make
-</pre>
-<h2 id="gtkradiant">
+</div>
+</div>
+
+<div id="gtkradiant" class="title">
 	GtkRadiant 1.5.0 support files (optional)
-</h2>
+</div>
+<div class="text">
 <p>
 	You can skip this section if you do not intent to create to create models with gtkradiant 1.5.
 	Note that these files probably won't work with other versions. You can find precompiled
@@ -237,43 +291,55 @@ make
 	directory on your system, edit these instructions accordingly.
 <p>
 	Copy the support files to the gtkradiant folder:
-<pre>
-cd data
-cd gtkradiant
+</p>
+<div class="code">
+cd data<br>
+cd gtkradiant<br>
 cp -vr * /usr/local/games/gtkradiant-1.5.0
-</pre>
+</div>
 <p>
 	Open the file <i>/usr/local/games/gtkradiant-1.5.0/games/osirion.game</i> in 
 	your favourite editor. Look for a line that begins with:
-<pre>
+</p>
+<div class="code">
 enginepath_linux="
-</pre>
+</div>
 <p>
 	Make sure it points to your osirion data directory. For example,
 	if you checked out the source code in <i>/home/yourname/osirion</i>, 
 	then the data will be in <i>/home/yourname/osirion/data</i> and 
 	the line should look like this:
-<pre>
+</p>
+<div class="code">
 enginepath_linux="/home/yourname/osirion/data"
-</pre>
+</div>
 <p>
 	Save the changes.
-<h2 id="source_data">
+</p>
+</div>
+
+<div id="source_data" class="title">
 	Source data (optional)
-</h2>
+</div>
+<div class="text">
 <p>
 	The .xcf and .svg source files used to create the game data
 	can also be downloaded. Note that you do not need these files
 	to play the game or to create .map models. You only have to 
 	download them them if you want to create new game graphics.
+</p>
 <p>
 	To download the source data from the subversion repository:
-<pre>
+</p>
+<div class="code">
 svn checkout svn://intranifty.no-ip.org/osirion-data-src data-src
-</pre>
-<h2 id="organization">
+</div>
+</div>
+
+<div class="title">
 Organization of the distribution
-</h2>
+</div>
+<div class="text">
 <pre>
 /doc 	Documentation
 
@@ -295,6 +361,7 @@ Organization of the distribution
 	/math			mathematical classes and functions
 	/sys			low-level system functions
 	/render			render library
+	/ui			user interface widget library
 
 /data	Data files
 
@@ -304,11 +371,10 @@ Organization of the distribution
 		/maps		game world models
 		/scripts	gtkradiant shader files
 		/textures	game world textures
+
 	/gtkradiant		gtkradiant support files
 </pre>
+</div>
 
-<h2 class="navigate">
-		<a href="index.html">back</a>
-</h2>
 </body>
 </html>
author	Stijn Buys <ingar@osirion.org>	2009-02-23 18:31:03 +0000
committer	Stijn Buys <ingar@osirion.org>	2009-02-23 18:31:03 +0000
commit	634b12e329b0e1e305490c6bc87ce414fd027add (patch)
tree	d978be6f96719e92cf89c743854a621a3c169263 /doc/installation.html
parent	1a4ae6ca5cd3aac0fd639c554e824525d98676ea (diff)