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. Or just do:
  15
  16      ./configure && make && make install
  17
  18 After installing, type "cboard -h" for command-line options or just "cboard"
  19 then press F1 for help on in-game command keys.
  20
  21 If you want PERL support you'll need to have libperl installed and pass
  22 --with-libperl to 'configure'. When compiled with PERL support, pressing ^O
  23 will "filter" the current game through a PERL subroutine defined in
  24 ~/.cboard/perl.pl. The subroutine is passed a single argument which is a
  25 generated FEN tag of the current game. The subroutine should return a FEN tag
  26 after processing.
  27
  28 The latest version can be found at https://gitlab.com/bjk/cboard/wikis. If
  29 you find a bug or have a patch to fix one or a feature request you can use the
  30 issue tracking system at https://gitlab.com/bjk/cboard/issues or send me an
  31 email.
  32
  33 There is also a public GIT repository available. Anonymous checkouts can be
  34 done by doing:
  35
  36     git clone https://gitlab.com/bjk/cboard.git
  37
  38 Ben Kibbey <bjk@luxsci.net>
  39 Jabber: bjk@jabber.org
  40 https://gitlab.com/bjk/cboard/wikis