README.md

   1 Cute Chess
   2 ==========
   3
   4 Cute Chess is a graphical user interface, command-line interface and a library
   5 for playing chess. Cute Chess is written in C++ using the [Qt
   6 framework](http://qt.nokia.com/).
   7
   8 Installing
   9 ----------
  10
  11 Binaries are available for `cutechess-cli`. The latest version is 0.5.1.
  12
  13 * [cutechess-cli GNU/Linux 32-bit](http://github.com/downloads/cutechess/cutechess/cutechess-cli-linux32.tar.gz)
  14 * [cutechess-cli GNU/Linux 64-bit](http://github.com/downloads/cutechess/cutechess/cutechess-cli-linux64.tar.gz)
  15 * [cutechess-cli OS X 64-bit](http://github.com/downloads/cutechess/cutechess/cutechess-cli-osx.zip)
  16 * [cutechess-cli Win32](http://github.com/downloads/cutechess/cutechess/cutechess-cli-win32.zip)
  17
  18 The GUI doesn't have a binary release at this time.
  19
  20 Compiling
  21 ---------
  22
  23 Cute Chess requires Qt 4.6 or greater and `qmake`. Qt 5 is not currently
  24 supported.
  25
  26 In the simplest case you only have to issue:
  27
  28     $ qmake
  29     $ make
  30
  31 If you are using the Visual C++ compiler replace `make` with `nmake`. To build
  32 on OS X add `-spec macx-g++` to the `qmake` command.
  33
  34 Documentation is available as Unix manual pages in the `docs/` directory.
  35
  36 API documentation can be built by issuing `make doc-api` (requires Doxygen).
  37
  38 License
  39 -------
  40
  41 Cute Chess is released under the GPLv3+ license except for the components in
  42 the `projects/lib/components` and `projects/gui/components` directories which
  43 are released under the MIT License.
  44
  45 Credits
  46 -------
  47
  48 Cute Chess was written by Ilari Pihlajisto and Arto Jonsson.