INSTALL

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