README

   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.
   8
   9 Since there are many variations of the curses library, CBoard requires
  10 NCurses to be installed to make porting to other operating systems
  11 easier. There are known issues with Sun/Solaris and NetBSD, although
  12 CBoard has been tested to work well on OpenBSD, FreeBSD and Linux.
  13
  14 Read INSTALL for generic build and installation details. After installing,
  15 type "cboard -h" for command-line options or just "cboard" then press F1 for
  16 help on in-game command keys.
  17
  18 If you want PERL support you'll need to have libperl installed and pass
  19 --with-libperl to 'configure'. When compiled with PERL support, pressing ^O
  20 will "filter" the current game through a PERL subroutine defined in
  21 ~/.cboard/perl.pl. The subroutine is passed a single argument which is a
  22 generated FEN tag of the current game. The subroutine should return a FEN tag
  23 after processing.
  24
  25 The latest version can be found at http://c-board.sourceforge.net/. Feel free
  26 to send me a description of any bugs you find along with the associated .pgn
  27 (if any), feature requests and patches.
  28
  29 There is also a public GIT repository available. Anonymous checkouts can be
  30 done by doing:
  31
  32     git clone git://repo.or.cz/cboard.git
  33
  34 The gitweb interface can be viewed at http://repo.or.cz/w/cboard.git.
  35
  36 Ben Kibbey <bjk@luxsci.net>
  37 Jabber: bjk@jabber.org
  38 http://c-board.sourceforge.net/