# HG changeset patch
# User Tero Marttila <terom@fixme.fi>
# Date 1233008758 -7200
# Node ID 9823e6cd1086b23b79d8ab6a1e3023424c9af85b
# Parent  b24ea587158955c63ca18d3a66e51a472d61d04f
some README text

diff -r b24ea5871589 -r 9823e6cd1086 README
--- a/README	Tue Jan 27 00:17:13 2009 +0200
+++ b/README	Tue Jan 27 00:25:58 2009 +0200
@@ -4,3 +4,39 @@
 
     Visit the project website at http://kg.qmsk.net/
 
+
+*** Compiling ***
+
+The project uses CMake for building. The recommended build procedure is as follows:
+
+ 1. Change into the build/ subdirectory of the source distribution tree
+
+    cd build
+
+ 2. Create the CMake build setup, either running `cmake ..` yourself, or using the provided script:
+
+    sh mkcmake.sh Release /path/to/install
+
+ 3. Compile the code using make, preferrably using -j on a multi-core platform :)
+    
+    make
+
+ 4. Install the resource files and the binary to $prefix/share/kg, $prefix/bin/kg
+    
+    make install
+
+ 5. You can now run the binary:
+
+    /path/to/install/bin/kg
+
+
+*** Options ***
+
+Behaviour of the game is controlled using command-line arguments. Run `kg --help` to see a list of them
+
+
+*** Playing ***
+
+See http://kg.qmsk.net/wiki/GameHelp for information about keyboard controls.
+
+