7

     8

*** Compiling ***

     9

    10

The project uses CMake for building. The recommended build procedure is as follows:

    11

    12

 1. Change into the build/ subdirectory of the source distribution tree

    13

    14

    cd build

    15

    16

 2. Create the CMake build setup, either running `cmake ..` yourself, or using the provided script:

    17

    18

    sh mkcmake.sh Release /path/to/install

    19

    20

 3. Compile the code using make, preferrably using -j on a multi-core platform :)

    21

    22

    make

    23

    24

 4. Install the resource files and the binary to $prefix/share/kg, $prefix/bin/kg

    25

    26

    make install

    27

    28

 5. You can now run the binary:

    29

    30

    /path/to/install/bin/kg

    31

    32

    33

*** Options ***

    34

    35

Behaviour of the game is controlled using command-line arguments. Run `kg --help` to see a list of them

    36

    37

    38

*** Playing ***

    39

    40

See http://kg.qmsk.net/wiki/GameHelp for information about keyboard controls.

    41

    42