INSTALL

   1
   2     Installation
   3
   4
   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.
   9
  10 If you're using Qt Creator to build the sources you can skip the rest of this
  11 document.
  12
  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.
  16
  17 To build the Makefile in release mode:
  18
  19     $ qmake -config release
  20
  21     or in debug mode:
  22
  23     $ qmake -config debug
  24
  25 And to build the source:
  26
  27     $ make
  28
  29     or
  30
  31     $ nmake (Visual C++)
  32
  33 To build on a Macintosh, add "-spec macx-g++" to the qmake command.
  34
  35 Documentation is available as Unix manual pages and in HTML format. Building
  36 the documentation in either format requires asciidoc
  37 (http://www.methods.co.nz/asciidoc/).
  38
  39     $ make doc-man     (documentation as Unix manual pages)
  40     $ make doc-html    (documentation in HTML format)
  41
  42 The documentation is built to the "docs" directory.
  43
  44 If you want to have an overview of Cute Chess' source you can build the API
  45 documentation:
  46
  47     $ make doc-api
  48
  49 You need doxygen (http://www.doxygen.org/) in order to build the API
  50 documentation.