Merge branch 'master' into utf8
[cboard.git] / README
blob5d6ca10ab503dacf33e60dc21e04a25cc596a358
1 CBoard is a Console/Curses PGN file browser, editor and interface to chess
2 engines supporting the XBoard protocol. It supports SAN move format with
3 annotations including RAV, NAG, single and multi-line comments along with the
4 FEN tag which can be edited by arranging pieces on the board. It can also
5 validate and save to (optionally reduced) PGN format. Multiple games
6 (human/human, human/engine, engine/engine) can be loaded, created, searched
7 and edited. You can also customize the key bindings and create macros.
9 Builds on Solaris, Linux, *BSD (but not NetBSD as it doesn't have libpanel
10 from libcurses for some reason), Darwin and Linux.
12 Read INSTALL for generic build and installation details. After installing,
13 type "cboard -h" for command-line options or just "cboard" then press F1 for
14 help on in-game command keys.
16 If you want PERL support you'll need to have libperl installed and pass
17 --with-libperl to 'configure'. When compiled with PERL support, pressing ^O
18 will "filter" the current game through a PERL subroutine defined in
19 ~/.cboard/perl.pl. The subroutine is passed a single argument which is a
20 generated FEN tag of the current game. The subroutine should return a FEN tag
21 after processing.
23 The latest version can be found at http://c-board.sourceforge.net/. Feel free
24 to send me a description of any bugs you find along with the associated .pgn
25 (if any), feature requests and patches.
27 There is also a public GIT repository available. Anonymous checkouts can be
28 done by doing:
30     git clone git://repo.or.cz/cboard.git
32 The gitweb interface can be viewed at http://repo.or.cz/w/cboard.git.
34 Ben Kibbey <bjk@luxsci.net>
35 Jabber: bjk@jabber.org
36 http://c-board.sourceforge.net/