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