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