Minor changes to documentation.
[yazpp-moved-to-github.git] / README.txt
1 YAZ++ - A C++ library for YAZ
2
3 $Id: README.txt,v 1.2 1999-01-28 10:04:46 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
10 YAZ++ is a C++ wrapper on top of that YAZ. It provides a relatively
11 simple, high level, interface to YAZ.
12
13 o Overview
14
15 YAZ++ builds a programmers' library libyaz++.lib and a few
16 example applications:
17   yaz-client   -  small client
18   yaz-server   -  small server
19   yaz-proxy    -  simple 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   -- unix (UNIX configure script and Makefile)
31   -- win (Windows build files)
32
33 o Installation, Unix
34
35 Make sure you have a C - and C++ compiler available. gcc and
36 g++ works fine.
37
38 Before compilation can take place YAZ must be installed. Unpack
39 yaz-<version>.tar.gz in the same directory as yaz++. First
40 build YAZ:
41
42   $ cd yaz-<version>
43   $ ./configure
44   $ make
45
46 Then, build YAZ++:
47
48   $ cd yaz++-<version>
49   $ cd unix
50   $ ./configure
51   $ make
52
53 o Installation, Windows
54
55 Software is 32-bit based and should run on Windows 95/98 and
56 Windows NT 4.0 The software was build using Microsoft Visual C++ 5.0 and
57 6.0. Other compilers should work but the makefile/project files will have
58 created for those compiler environments.
59   > cd win
60   > nmake      (Visual C++ makefile not yet created)
61