From de2a9831d5f0198165b911f182d4fbd18bb60c50 Mon Sep 17 00:00:00 2001 From: Arto Jonsson Date: Sat, 7 Apr 2012 19:37:57 +0300 Subject: [PATCH] Combine INSTALL into README.md Simplify installation instructions to cover the usual case. Link cutechess-cli binaries while here. --- INSTALL | 43 ------------------------------------------- README.md | 27 +++++++++++++++++++++++++-- 2 files changed, 25 insertions(+), 45 deletions(-) delete mode 100644 INSTALL diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 82049ee..0000000 --- a/INSTALL +++ /dev/null @@ -1,43 +0,0 @@ - - Installation - - -Cute Chess requires Qt (at least version 4.6) and qmake (the Qt Makefile -generator). The current qmake project file doesn't have support for -installations. However the main executable has the necessary resources built-in -by default so it's the only thing you need to deploy. - -If you're using Qt Creator to build the sources you can skip the rest of this -document. - -First you need to build Cute Chess' Makefile in either release or debug mode. -Release mode is for general program usage and offers the best performance. -Debug mode is for debugging Cute Chess. - -To build the Makefile in release mode: - - $ qmake -config release - - or in debug mode: - - $ qmake -config debug - -And to build the source: - - $ make - - or - - $ nmake (Visual C++) - -To build on a Macintosh, add "-spec macx-g++" to the qmake command. - -Documentation is available as Unix manual pages in the "docs" directory. - -If you want to have an overview of Cute Chess' source you can build the API -documentation: - - $ make doc-api - -You need doxygen (http://www.doxygen.org/) in order to build the API -documentation. diff --git a/README.md b/README.md index 253000b..0793011 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,35 @@ Cute Chess is a graphical user interface, command-line interface and a library for playing chess. Cute Chess is written in C++ using the [Qt framework](http://qt.nokia.com/). -Install -------- +Installing +---------- + +Binaries are available for `cutechess-cli`. The latest version is 0.5.1. + +[cutechess-cli GNU/Linux 32-bit](http://github.com/downloads/cutechess/cutechess/cutechess-cli-linux32.tar.gz) +[cutechess-cli GNU/Linux 64-bit](http://github.com/downloads/cutechess/cutechess/cutechess-cli-linux64.tar.gz) +[cutechess-cli OS X 64-bit](http://github.com/downloads/cutechess/cutechess/cutechess-cli-osx.zip) +[cutechess-cli Win32](http://github.com/downloads/cutechess/cutechess/cutechess-cli-win32.zip) + +The GUI doesn't have a binary release at this time. + +Compiling +--------- + +Cute Chess requires Qt 4.6 or greater and `qmake`. + +In the simplest case you only have to issue: $ qmake $ make +If you are using the Visual C++ compiler replace `make` with `nmake`. To build +on OS X add `-spec macx-g++` to the `qmake` command. + +Documentation is available as Unix manual pages in the `docs/` directory. + +API documentation can be built by issuing `make doc-api` (requires Doxygen). + Credits ------- -- 2.11.4.GIT