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