Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStijn Buys <ingar@osirion.org>2008-09-27 18:59:02 +0000
committerStijn Buys <ingar@osirion.org>2008-09-27 18:59:02 +0000
commit8307192be1d246988112bf02128bb3ab68773aa5 (patch)
tree8ba66deace4216bec1a9dabc5f4bc7b75d3ea545 /doc
parentca0c1d3e6f8b5fa4eb2e0a86fcf47b12fb600786 (diff)
documentation updates
Diffstat (limited to 'doc')
-rw-r--r--doc/installation.html83
-rw-r--r--doc/style.css3
2 files changed, 50 insertions, 36 deletions
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.
<ul>
- <li><a href="#precompiled">Downloading a precompiled package</a>
+ <li><a href="#precompiled">Using precompiled executables</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">
- Downloading a precompiled package
+ Using precompiled executables
</h2>
<p>
You can find the latest version in the download section of the website:<br>
@@ -32,19 +32,26 @@
Windows
</h3>
<p>
- Download the windows package:<br>
- <a href="http://ingar.satgnu.net/osirion/files/osirion-latest-win32.zip">osirion-latest-win32.zip</a><br>
- This packages contains the win32 version of the server, the client and the game data.
+ Download the windows executables 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.
<p>
- Unzip the package to an approriate directory. Open the directory in explorer and
- click on <i>osirion.exe</i> to start the client.
+ 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 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
+ <i>D:\Osirion</i> then there should be a directory <i>D:\Osirion\data\base</i> containing the
+ game data.
+<p>
+ Open the game directory in explorer and click on <i>osirion.exe</i> to start the client.
<h3>
Linux
</h3>
<p>
- Download the linux package:<br>
- <a href="http://ingar.satgnu.net/osirion/files/osirion-latest-linux.zip">osirion-latest-linux.zip</a><br>
- This packages contains the linux x86 and x86_64 version of the server, the client and the game data.
+ Download the linux executables 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.
<p>
Extract the package, a new subdirectory will be created. The actual directory name will depend on
the version number. Enter the new subdirectory.
@@ -53,6 +60,14 @@ tar jxvf osirion-latest.tar.bz2
cd osirion-0.1_258-linux
</pre>
<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>
+unzip ../osirion-data-latest.zip
+</pre>
+<p>
To run the 32bit client:
<pre>
./osirion.x86
@@ -71,34 +86,33 @@ cd osirion-0.1_258-linux
<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.
-
<p>
To build the client or the dedicated server:
- <table>
- <tr><td>zlib</td><td></td></tr>
- </table>
+ <ul>
+ <li>zlib
+ </ul>
<p>
To build the client:
- <table>
- <tr><td>libSDL 1.2</td></tr>
- <tr><td>libpng</td></tr>
- <tr><td>libjpeg-6b<td></tr>
- <tr><td>OpenGL</td></tr>
- <tr><td>OpenAL 1.1</td></tr>
- </table>
+ <ul>
+ <li>libSDL 1.2
+ <li>libpng
+ <li>libjpeg-6b
+ <li>OpenGL
+ <li>OpenAL 1.1
+ </ul>
<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:
-<table>
- <tr><td>linux-x86_64</td><td>gcc 4.3.1</td></tr>
- <tr><td>linux-x86_64</td><td>gcc 4.1.2</td></tr>
- <tr><td>linux-i686</td><td>gcc 4.1.2</td></tr>
- <tr><td>mingw32 </td><td>gcc 4.2.2</td></tr>
-</table>
-
+ <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>
@@ -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 <i>osirion</i> and download the source code into it.
<pre>
-svn co svn://intranifty.no-ip.org/osirion
+svn co svn://intranifty.no-ip.org/osirion osirion
</pre>
<p>
On windows, you can use the Turtoisesvn SubVersion client to access the
@@ -117,7 +131,7 @@ svn co svn://intranifty.no-ip.org/osirion
<a href="http://tortoisesvn.tigris.org/">http://tortoisesvn.tigris.org/</a>
<p>
You can also get the source package from the website:<br>
- <a href="http://ingar.satgnu.net/osirion/files/osirion-latest-src.tar.bz2">osirion-latest-src.tar.bz2</a>
+ <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>
@@ -148,13 +162,12 @@ make
<p>
The binaries will be build in the <i>src</i> subdirectory of the main distribution.
<h3>
- Obtaining the game data
+ Obtaining the game data
</h3>
<p>
The game data should be located in the <i>data</i> 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:<br>
- <a href="svn://intranifty.no-ip.org/osirion">svn://intranifty.no-ip.org/osirion-data</a>
+ 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>
Run the following command from within the main distribution directory to download
the game data into the <i>data</i> subdirectory:
@@ -192,7 +205,7 @@ src/osiriond
Update the source code:
<pre>
cd osirion
-make distclean
+make clean
svn update
</pre>
<p>
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;