Added LICENSE file.
[yazpp-moved-to-github.git] / README.txt
1 YAZ++ - A C++ library for YAZ
2
3 $Id: README.txt,v 1.5 2000-09-13 12:22:32 adam Exp $
4  
5 o Introduction
6
7 YAZ is a development toolkit that implements the ANSI Z39.50 protocol.
8 YAZ homepage is: http://www.indexdata.dk/yaz/
9 YAZ++ uses the same license as YAZ - see LICENSE file for
10 details.
11
12 YAZ++ is a C++ wrapper on top of that YAZ and provides a relatively
13 simple interface to YAZ.
14
15 o Overview
16
17 YAZ++ builds a programmers' library libyaz++.lib and a few
18 example applications:
19   yaz-client   -  small client
20   yaz-server   -  small server
21   yaz-proxy    -  simple proxy server
22
23 Description in HTML format of object model can be found in the sub
24 directory doc. The top-page of the documentaion is index.html. The
25 documentation was auto-generated from YAZ++ source using doc++.
26
27 Directory structure of the YAZ++ package.
28
29   -- src (C++ source)
30   -- include (C++ headers) 
31   -- doc (documentation)
32   -- unix (UNIX configure script and Makefile)
33   -- win (Windows build files)
34
35 o Installation, Unix
36
37 Make sure you have a C - and C++ compiler available. gcc and
38 g++ works fine.
39
40 Before compilation can take place YAZ must be installed. Unpack
41 yaz-<version>.tar.gz in the same directory as yaz++. First
42 build YAZ:
43
44   $ cd yaz-<version>
45   $ ./configure
46   $ make
47
48 Then, build YAZ++:
49
50   $ cd yaz++-<version>
51   $ cd unix
52   $ ./configure
53   $ make
54
55 o Installation, Windows
56
57 Software is WIN32 and should run on Windows 95/98 and Windows NT 4.0.
58 Yaz++ was build using Microsoft Visual C++ 6.0. Other compilers should
59 work but makefile/project files will have to be created for those
60 compiler environments.
61
62   Workspace yazxx.dsw includes the projects
63     yazxx.dsp       -   builds yazxx.dll
64     yazclient.dsp   -   builds yazclient.exe
65     yazserver.dsp   -   builds yazserver.exe
66     yazproxy.dsp    -   builds yazproxy.exe