Minor changes to documentation.

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

diff --git a/README.txt b/README.txt
index c7a07e5..a403eb9 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,35 +1,61 @@
 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.2 1999-01-28 10:04:46 adam Exp $
  
 o Introduction
 
-YAZ is development toolkit that implements the ANSI Z39.50 protocol.
+YAZ is a development toolkit that implements the ANSI Z39.50 protocol.
 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.
 
-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   -  small client
+  yaz-server   -  small server
+  yaz-proxy    -  simple 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.
+
+  -- src (C++ source)
+  -- include (C++ headers) 
+  -- doc (documentation)
+  -- unix (UNIX configure script and Makefile)
+  -- win (Windows build files)
+
+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. Unpack
-yaz-<version>.tar.gz in the same directory as yaz++. 
+yaz-<version>.tar.gz in the same directory as yaz++. First
+build YAZ:
+
+  $ cd yaz-<version>
+  $ ./configure
+  $ make
 
-For Unix - make sure you have a C++ compiler available. g++ works fine.
+Then, build YAZ++:
+
+  $ cd yaz++-<version>
   $ cd unix
   $ ./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.
+o Installation, Windows
+
+Software is 32-bit based and should run on Windows 95/98 and
+Windows NT 4.0 The software was build using Microsoft Visual C++ 5.0 and
+6.0. Other compilers should work but the makefile/project files will have
+created for those compiler environments.
   > cd win
   > nmake      (Visual C++ makefile not yet created)