zoom/README

   1 This is an initial implementation of the ZOOM C++ binding
   2 (http://zoom.z3950.org/bind/cplusplus/) for the Yaz toolkit.
   3 It's a rather obvious thin layer on top of Yaz's ZOOM-C
   4 implementation.
   5
   6 Only one wrinkle, really: we want the ZOOM C++ header file for two
   7 different purposes: one is to function as an interface specification
   8 that can go on the ZOOM web-site, and one is to actually build
   9 against.  The requirements of these two manifestations of the header
  10 file are rather different in that the latter needs to include
  11 implementation details that the former very explicitly does _not_
  12 want.  Accordingly, we automatically generate both versions from a
  13 master copy in which the implementation-dependent lines are preceded
  14 by asterisks ("*").  So we have:
  15
  16         master-header   The master copy, which may be edited.
  17         interface.h     The read-only, automatically-generated file
  18                         that can be considered a formal specification
  19                         of the ZOOM C++ interface.
  20         zoom.h          The read-only, automatically-generated file
  21                         that is actually used in the build process,
  22                         and ultimately installed into
  23                         ../include/yaz++/zoom.h
  24
  25 Documentation (in DocBook format) is in "../doc/zoom.xml"