X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=zoom%2FREADME;h=581c7be397766f8e626fc62242b4914b8f9af0fb;hb=3f60ee904bd42b93051a01ac88fadca365101368;hp=729a4d632e59de0b04ed935e9d21ea03c7f814e6;hpb=8e0f7888835eb1a84882b440209ec125ce5856c1;p=yazpp-moved-to-github.git diff --git a/zoom/README b/zoom/README index 729a4d6..581c7be 100644 --- a/zoom/README +++ b/zoom/README @@ -3,9 +3,6 @@ This is an initial implementation of the ZOOM C++ binding It's a rather obvious thin layer on top of Yaz's ZOOM-C implementation. -The build environment will no doubt need to be tweaked to fit -in with the way that the rest of Yaz++ is built. - Only one wrinkle, really: we want the ZOOM C++ header file for two different purposes: one is to function as an interface specification that can go on the ZOOM web-site, and one is to actually build @@ -14,15 +11,15 @@ file are rather different in that the latter needs to include implementation details that the former very explicitly does _not_ want. Accordingly, we automatically generate both versions from a master copy in which the implementation-dependent lines are preceded -by asterisks(*). So we have: +by asterisks ("*"). So we have: master-header The master copy, which may be edited. interface.h The read-only, automatically-generated file that can be considered a formal specification of the ZOOM C++ interface. - zoom++.h The read-only, automatically-generated file + zoom.h The read-only, automatically-generated file that is actually used in the build process, - and ought quite possibly to be moved into + and ultimately installed into ../include/yaz++/zoom.h -Good luck! +Documentation (in DocBook format) is in "../doc/zoom.xml"