INSTALL

   1
   2     Installation
   3
   4
   5 Cute Chess requires Qt (at least version 4.6), qmake (the Qt Makefile
   6 generator) and QJson. 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.
   9
  10 First you need to make sure that QJson is installed. On Unix and derivates you
  11 should be able to install it through package manager. 0.7.0+ version of QJson
  12 is highly recommended due to problems in earlier versions. On Windows the
  13 easiest way is to drop the QJson source files to "3rdparty/qjson/" directory
  14 under "projects/lib" and make a local installation of QJson. So, with 'cmake'
  15 program installed in "3rdparty/qjson/" directory:
  16
  17     cmake -DCMAKE_INSTALL_PREFIX=.
  18     make
  19     make install
  20
  21 QJSon is now installed to the current directory where Cute Chess' build system
  22 will pick it up.
  23
  24 Next you need to build Cute Chess' Makefile in either release or debug mode.
  25 Release mode is for general program usage and offers the best
  26 performance. Debug mode is for debugging Cute Chess.
  27
  28 To build the Makefile in release mode:
  29
  30     $ qmake -config release
  31
  32     or in debug mode:
  33
  34     $ qmake -config debug
  35
  36 And to build the source:
  37
  38     $ make
  39
  40     or
  41
  42     $ nmake (Visual C++)
  43
  44 To build on a Macintosh, add "-spec macx-g++" to the qmake command.
  45
  46 Documentation is available as Unix manual pages and in HTML format. Building
  47 the documentation in either format requires asciidoc
  48 (http://www.methods.co.nz/asciidoc/).
  49
  50     $ make doc-man     (documentation as Unix manual pages)
  51     $ make doc-html    (documentation in HTML format)
  52
  53 The documentation is built to the "docs" directory.
  54
  55 If you want to have an overview of Cute Chess' source you can build the API
  56 documentation:
  57
  58     $ make doc-api
  59
  60 You need doxygen (http://www.doxygen.org/) in order to build the API
  61 documentation.