Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStijn Buys <ingar@osirion.org>2008-02-06 20:05:10 +0000
committerStijn Buys <ingar@osirion.org>2008-02-06 20:05:10 +0000
commit884667848ecf043dd2d8c5421250c88931151bd1 (patch)
tree711544a3d4a9e16ae260b4131b6da1c9f0fdb7c2 /INSTALL
parent15ca94f41b77cdf439774fe1e6502979be9d3f8e (diff)
Documentation updates
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL83
1 files changed, 65 insertions, 18 deletions
diff --git a/INSTALL b/INSTALL
index 1ee3364..62061b3 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,29 +1,76 @@
-Basic Installation
-==================
-To build the Osirion Project from source you will need
-the SDL and OpenGL library and header files.
+Installation
-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 (client only!)
+ To build the Osirion Project from source code you will need
+ the SDL and OpenGL library and header files.
-Compile the source by executing the following commands:
+ In theory, it should compile on any platform supported by SDL,
+ but at the time of writing only linux is supported.
- autoreconf -fi
- ./configure
- make
+ I have succesfully compiled it on the following platforms:
+ linux-x86_64, gcc 4.1.2, SDL 1.2.11
-To run the client program, execute:
+Obtaining the source code
- src/osirion
+ Get the latest version of the source code from svn:
-To run the dedicated server, execute:
+ svn checkout svn://intranifty.no-ip.org/osirion
- src/osiriond
+ This command will create a new subdirectory 'osirion'
+ and download the source code into it.
-The game data files should be located in the subdirectory
-data/base of the main distribution.
+Compilint the source code
+ Enter the new directory and compile the source code:
+
+ cd osirion/
+ autoreconf -fi
+ ./configure
+ make
+
+ At present, 'make install' is neither tested nor supported
+
+Game Data
+
+ The game data should be located in the 'data'
+ subdirectory of the main distribution.
+
+ Get the latest version of the game data from svn:
+ Run the following command from within the main
+ distribution directory:
+
+ svn checkout svn://intranifty.no-ip.org/osirion-data data
+
+Executing
+
+ To run the client program, execute:
+
+ src/osirion
+
+ To run the dedicated server, execute:
+
+ src/osiriond
+
+Updating
+
+ If you downloaded and compiled the game before,
+ there is no need to re-download the entire distribution.
+
+ Update the game source code with the following commands:
+
+ cd osirion/
+ make distclean
+ svn update
+
+ Rebuild the game:
+
+ autoreconf -fi
+ ./configure
+ make
+
+ Update the game data:
+
+ cd data/
+ svn update
+ cd ..