Additional files described.
authorMike Taylor <mike@indexdata.com>
Tue, 17 Jan 2006 10:35:12 +0000 (10:35 +0000)
committerMike Taylor <mike@indexdata.com>
Tue, 17 Jan 2006 10:35:12 +0000 (10:35 +0000)
doc/README

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