Yet another WIN32 fix for connect notify.

[yazpp-moved-to-github.git] / README.txt

diff --git a/README.txt b/README.txt
index c7a07e5..e1a7d5d 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,35 +1,62 @@
 YAZ++ - A C++ library for YAZ
 
-$Id: README.txt,v 1.1 1999-01-28 09:41:07 adam Exp $
+$Id: README.txt,v 1.7 2000-10-26 21:31:50 adam Exp $
  
 o Introduction
 
-YAZ is development toolkit that implements the ANSI Z39.50 protocol.
-YAZ homepage is: http://www.indexdata.dk/yaz
+YAZ++ is a C++ layer for YAZ and implements the ANSI Z39.50
+protocol for information retrieval (client - and server side).
+YAZ homepage is: http://www.indexdata.dk/yaz/
 
-YAZ++ is a C++ wrapper on top of that YAZ. It provides a relatively
-simple, high level, interface to YAZ.
+YAZ++ uses the same license as YAZ - see LICENSE file for details.
 
-o Documentatation
+o Overview
 
-Description of object model can be found in the sub directory doc, file
-index.html.
+YAZ++ builds a programmers' library libyaz++.lib and a few
+example applications:
+  yaz-client++       basic client
+  yaz-server++       basic server
+  yaz-proxy          proxy server
 
-The documentation was auto-generated from source using doc++.
+Description in HTML format of object model can be found in the sub
+directory doc. The top-page of the documentaion is index.html. The
+documentation was auto-generated from YAZ++ source using doc++.
 
-o Installation
+Directory structure of the YAZ++ package.
 
-Before compilation can take place YAZ must be installed. Unpack
-yaz-<version>.tar.gz in the same directory as yaz++. 
+  -- src (C++ source)
+  -- include (C++ headers) 
+  -- doc (documentation)
+  -- win (Windows build files)
 
-For Unix - make sure you have a C++ compiler available. g++ works fine.
-  $ cd unix
+o Installation, Unix
+
+Make sure you have a C - and C++ compiler available. gcc and
+g++ works fine.
+
+Before compilation can take place YAZ must be installed. It goes, roughly,
+like this:
+
+  $ cd yaz-<version>
+  $ ./configure
+  $ make
+  $ cd ..
+
+Then, build YAZ++:
+
+  $ cd yaz++-<version>
   $ ./configure
   $ make
 
-For Windows. The software was build using Microsoft Visual C++ 5.0 and
-6.0. Other compilers should work but the makefile will have to be
-modified.
-  > cd win
-  > nmake      (Visual C++ makefile not yet created)
+o Installation, Windows
+
+Software is WIN32 and should run on Windows 95/98 and Windows NT 4.0.
+Yaz++ was build using Microsoft Visual C++ 6.0. Other compilers should
+work but makefile/project files will have to be created for those
+compiler environments.
 
+  Workspace yazxx.dsw includes the projects
+    yazxx.dsp       -   builds yazxx.dll
+    yazclient.dsp   -   builds yazclient.exe
+    yazserver.dsp   -   builds yazserver.exe
+    yazproxy.dsp    -   builds yazproxy.exe