doc/README

   1 $Id: README,v 1.2 2006-01-17 10:35:12 mike Exp $
   2
   3 This directory contains documentation generated by human hands.  In
   4 contrast, ../dox contains documentation automatically generated by
   5 doxygen from the API declarations.
   6
   7 Eventually, everything in this directory will become an integrated YP2
   8 manual written in DocBook, like the YAZ and Zebra manuals.  For now,
   9 though, we have separate files, which might perhaps best be read in
  10 the specified order:
  11
  12 README -- this file.
  13 filters -- lists and briefly describes the various filters.
  14 config -- describes the YP2 configuration file.
  15 multidb -- virtual databases and multi-db searching (complicated!)
  16 classes -- describes some of the classes in the YP2 source code.
  17