INSTALL

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