Combine README and AUTHORS to README.md
[sloppygui.git] / INSTALL
blob82049eea123503884571c7be39910fe35f34d796
2     Installation
5 Cute Chess requires Qt (at least version 4.6) 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 built-in
8 by default so it's the only thing you need to deploy.
10 If you're using Qt Creator to build the sources you can skip the rest of this
11 document.
13 First you need to build Cute Chess' Makefile in either release or debug mode.
14 Release mode is for general program usage and offers the best performance.
15 Debug mode is for debugging Cute Chess.
17 To build the Makefile in release mode:
19     $ qmake -config release
21     or in debug mode:
23     $ qmake -config debug
25 And to build the source:
27     $ make
29     or
31     $ nmake (Visual C++)
33 To build on a Macintosh, add "-spec macx-g++" to the qmake command.
35 Documentation is available as Unix manual pages in the "docs" directory.
37 If you want to have an overview of Cute Chess' source you can build the API
38 documentation:
40     $ make doc-api
42 You need doxygen (http://www.doxygen.org/) in order to build the API
43 documentation.