Update INSTALL file to reflect the config changes.
[sloppygui.git] / INSTALL
bloba4b79625d8fc2e7b91769afe69140776ce03ddb2
2     Installation
5 Cute Chess requires Qt (atleast version 4.4) and qmake, the Qt Makefile
6 generator. The current qmake project file doesn't have support for
7 installations. However the main executable has the necessary resources
8 built-in by default so it's the only thing you need to deploy.
10 First you need to build the Makefile in either release or debug mode.
11 Release mode is for general program usage and offers the best
12 performance. Debug mode is for debugging Cute Chess.
14 To build the Makefile in release mode (default):
16     $ qmake
18     or in debug mode:
20     $ qmake "CONFIG += debug"
22 And to build the source:
24     $ make
26     or
28     $ nmake (Visual C++)
30 Manual page is available but you have to built it separately. Building it
31 requires asciidoc (http://www.methods.co.nz/asciidoc/).
33     $ make doc-man
35 If you want to have an overview of Cute Chess's source you can build the API
36 documentation:
38     $ make doc-api
40 You need doxygen (http://www.doxygen.org/) in order to build the API
41 documentation.