From 8307192be1d246988112bf02128bb3ab68773aa5 Mon Sep 17 00:00:00 2001 From: Stijn Buys Date: Sat, 27 Sep 2008 18:59:02 +0000 Subject: documentation updates --- doc/installation.html | 83 +++++++++++++++++++++++++++++---------------------- doc/style.css | 3 +- 2 files changed, 50 insertions(+), 36 deletions(-) (limited to 'doc') diff --git a/doc/installation.html b/doc/installation.html index e9a075f..c6c972c 100644 --- a/doc/installation.html +++ b/doc/installation.html @@ -17,13 +17,13 @@ either download a precompiled package from the website, or you can obtain the source code and compile it yourself.

- Downloading a precompiled package + Using precompiled executables

You can find the latest version in the download section of the website:
@@ -32,19 +32,26 @@ Windows

- Download the windows package:
- osirion-latest-win32.zip
- This packages contains the win32 version of the server, the client and the game data. + Download the windows executables package:
+ osirion-win32-latest.zip
+ This packages contains the win32 version of the server and the client.

- Unzip the package to an approriate directory. Open the directory in explorer and - click on osirion.exe to start the client. + Dowload the game data package:
+ osirion-data-latest.zip
+

+ Unzip the executables package into an approriate directory. Unzip the gama data package + into this directory. For example, if you unzipped the data and the executables into + D:\Osirion then there should be a directory D:\Osirion\data\base containing the + game data. +

+ Open the game directory in explorer and click on osirion.exe to start the client.

Linux

- Download the linux package:
- osirion-latest-linux.zip
- This packages contains the linux x86 and x86_64 version of the server, the client and the game data. + Download the linux executables packages:
+ osirion-linux-latest.zip
+ This packages contains the linux x86 and x86_64 versions of the client and the server.

Extract the package, a new subdirectory will be created. The actual directory name will depend on the version number. Enter the new subdirectory. @@ -52,6 +59,14 @@ tar jxvf osirion-latest.tar.bz2 cd osirion-0.1_258-linux +

+ Dowload the game data package:
+ osirion-data-latest.zip
+

+ Unzip it: +

+unzip ../osirion-data-latest.zip
+

To run the 32bit client: 

@@ -71,34 +86,33 @@ cd osirion-0.1_258-linux
 

 	To build The Osirion Project from source code you will need to have
 	the following libraries and their header files installed on your system.
-
 

 	To build the client or the dedicated server:
-	
-		
-	
zlib

+	

 

 	To build the client:
-	
-		
-		
-		
-		
-		
-	
libSDL 1.2
libpng
libjpeg-6b
OpenGL
OpenAL 1.1

+	

 

 	You will also need a recent version of gcc, GNU make, automake and libtool.
 

 	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:
-
-	
-	
-	
-	
-
linux-x86_64gcc 4.3.1
linux-x86_64gcc 4.1.2
linux-i686gcc 4.1.2
mingw32	gcc 4.2.2

-
+	

 

 	Obtaining the source code
 

@@ -109,7 +123,7 @@ cd osirion-0.1_258-linux
 	On linux, you can use the Subversion command line client tool. The following 
 	command will create a new subdirectory osirion and download the source code into it.
 
-svn co svn://intranifty.no-ip.org/osirion
+svn co svn://intranifty.no-ip.org/osirion osirion
 

 

 	On windows, you can use the Turtoisesvn SubVersion client to access the
@@ -117,7 +131,7 @@ svn co svn://intranifty.no-ip.org/osirion
 	http://tortoisesvn.tigris.org/
 

 	You can also get the source package from the website:

-	osirion-latest-src.tar.bz2
+	osirion-src-latest.tar.bz2
 

 	Compiling the source code
 

@@ -148,13 +162,12 @@ make
 

 	The binaries will be build in the src subdirectory of the main distribution.
 

-	Obtaining the game data
+	Obtaining the game data 
 

 

 	The game data should be located in the data subdirectory of the main distribution.
-	The data is not included with the source distribution. You will have to copy it from
-	a binary package or download it from the osirion-data subversion repository:

-	svn://intranifty.no-ip.org/osirion-data
+	You can use the game data package from the website or get it from the osirion-data subversion repository:

+	svn://intranifty.no-ip.org/osirion-data
 

 	Run the following command from within the main distribution directory to download
 	the game data into the data subdirectory:
@@ -192,7 +205,7 @@ src/osiriond
 	Update the source code:
 
 cd osirion
-make distclean
+make clean
 svn update
 

 

diff --git a/doc/style.css b/doc/style.css
index 614f437..68a8e19 100644
--- a/doc/style.css
+++ b/doc/style.css
@@ -65,11 +65,12 @@ td.narrow {
 pre {
  font-family: "Courier New", "Courier", "fixed";
  font-size: 14px;
- margin-left:96px;
+ margin-left: 64px;
  margin-right: 64px;
  width: auto;
  background-color: e5e5e5;
  padding: 8px;
+ padding-left: 16px;
 }
 ul {
  list-style-type: none;
-- 
cgit v1.2.3