README
author Tero Marttila <terom@fixme.fi>
Tue, 27 Jan 2009 00:25:58 +0200
changeset 439 9823e6cd1086
parent 405 7a8c7a0a1261
permissions -rw-r--r--
some README text

                              Kisna Glista
==============================================================================

    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.