Changed decode failure handling a bit so that failNotify is called.
[yazpp-moved-to-github.git] / README
1 YAZ++ AKA yazpp - A C++ library for YAZ and a ZOOM C++ API.
2
3 Introduction
4 ------------
5
6 YAZ++ is a set of libraries and header files that make it easier to
7 use the the YAZ toolkit from C++, together with some utilities written
8 using these libraries. It includes an implementation of the C++ binding
9 for ZOOM.
10
11 YAZ++ and ZOOM C++ use the same BSD-like license as YAZ - see LICENSE
12 file for details.
13
14 Documentation
15 -------------
16
17 The "doc" directory contains documentation in HTML and PDF.
18 You can also read it online at http://www.indexdata.dk/yazplusplus/
19
20 Overview
21 --------
22
23 YAZ++ builds a programmers' library libyaz++.lib and a few
24 applications:
25
26   yaz-my-client      basic client
27   yaz-my-server      basic server
28   zclient            basic ZOOM client
29
30 Directory structure of the YAZ++ package:
31
32   -- src (C++ library)
33   -- zoom (C++ source for ZOOM)
34   -- include/yaz++ (C++ headers) 
35   -- win (Windows build files)
36   -- doc (DocBook-format documentation)
37
38 ZOOM-C++
39 --------
40
41 The ZOOM library in this distribution implements the ZOOM C++ binding
42 described on the ZOOM web-site at 
43         http://zoom.z3950.org/bind/cplusplus/index.html
44 It provides a simple but powerful API for constructing Z39.50 client
45 applications.  See the documentation in doc/zoom.xml for much more
46 information.