Read Me(Knight-Path)                                      Read Me(Knight-Path)



DESCRIPTION
       The  knight-path(1)  command  is  used to calculate the shortest path a
       knight piece can take between two squares on a chess board.

BUILDING
       This is traditional open source software, and the  usual  build  method
       applies.  After fetching the tarball, do the following:

              $ tar xzf knight-path-.tar.gz
              $ cd knight-path-
              $ ./configure --prefix=/usr
              $ make
              $

       The software includes a test suite:

              $ make sure
              Passed all tests.
              $

       If you wish to install the software, only one more command is required:

              $ make install
              $

       All done.  See the knight-path(1) man page for more how to use it.

CODE LAYOUT
       The  source  code  for  the knight-path(1) program will be found in the
       top-level knight-path directory.  All the C++ files  below  that  point
       are compiled and linked together.  (Plus, there is some code in the lib
       directory, that would be shared if I  added  another  program  to  this
       project.)

       Below  the  knight-path  directory, the directory hierarchy follows the
       class hierarchy.  For  example:  the  solver  abstract  base  class  is
       knight-path/solver.h      and      its      derives     classes     are
       knight-path/solver/name.h, and so on.

       The Makefile takes care of all of this, non-recursively.  You only need
       to know this if you are going to be reading the code.

       The  source code contains full Doxygen documentation.  If desired, this
       could be extracted and turned into HTML  pages.   See  http://www.doxy-
       gen.org/ for more information.

COPYRIGHT
       knight-path version 1.0
       Copyright (C) 2011 Peter Miller

       The knight-path program comes with ABSOLUTELY NO WARRANTY; this is free
       software and you are welcome to redistribute it  under  certain  condi-
       tions; for details see the LICENSE file in the source tarball.

AUTHOR
       Peter Miller   E-Mail:   pmiller@opensource.org.au
       /\/\*             WWW:   http://miller.emu.id.au/pmiller/



Reference Manual                  Knight-Path             Read Me(Knight-Path)