Added ZOOM.
[yazpp-moved-to-github.git] / 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 The build environment will no doubt need to be tweaked to fit
7 in with the way that the rest of Yaz++ is built.
8
9 Only one wrinkle, really: we want the ZOOM C++ header file for two
10 different purposes: one is to function as an interface specification
11 that can go on the ZOOM web-site, and one is to actually build
12 against.  The requirements of these two manifestations of the header
13 file are rather different in that the latter needs to include
14 implementation details that the former very explicitly does _not_
15 want.  Accordingly, we automatically generate both versions from a
16 master copy in which the implementation-dependent lines are preceded
17 by asterisks(*).  So we have:
18
19         master-header   The master copy, which may be edited.
20         interface.h     The read-only, automatically-generated file
21                         that can be considered a formal specification
22                         of the ZOOM C++ interface.
23         zoom++.h        The read-only, automatically-generated file
24                         that is actually used in the build process,
25                         and ought quite possibly to be moved into
26                         ../include/yaz++/zoom.h
27
28 Good luck!