Minor changes.

[yaz-moved-to-github.git] / README

diff --git a/README b/README
index 79ec0a5..e4e66d8 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
 
- * Copyright (C) 1995-1998, Index Data.
+ * Copyright (C) 1995-1999, Index Data ApS.
  * See the file LICENSE for details.
  * Sebastian Hammer, Adam Dickmeiss
 
 Compilation and installation for YAZ 
-  $Id: README,v 1.21 1998-01-29 14:08:43 adam Exp $
+  $Id: README,v 1.26 1999-06-09 14:37:37 adam Exp $
 
 The primary output of the source here is the lib/libyaz.a library,
 which contains support functions for implementing the server or client
@@ -13,6 +13,9 @@ role of Z39.50/SR.
 Windows programmers: refer to the file windows.txt which describes
 how to compile the software using Microsoft Visual C++.
 
+On Unix, GNU configure is used to configure YAZ and generate Makefiles.
+Type "./configure", then "make" to build YAZ.
+
 Two test-programs of interest are generated when you type 'make' at the
 top level: ztest/ztest and client/client. Ztest is a dummy database
 server which returns canned responses to all queries. It's good for
@@ -76,17 +79,18 @@ value. If no = is in the SortKey it is treated as a sortfield-type
 of type InternationalString. Flags observed are s (sort case
 sensitive), i (sort case insensitive), < (ascending), > (descending).
 Eg.:
-   1=4   i>                  (use is title, insensitive, ascending).
-   Title s<                  (String Title, sensitive, descending).
+   1=4   i<                  (use is title, insensitive, ascending).
+   Title s>                  (String Title, sensitive, descending).
 
 The directories:
 
 doc     - Documentation.
 
 util    - Various little utility functions. Logging, memory debugging,
-       primitive ISO 2709 presentation for the client, etc.
+       primitive ISO 2709 presentation for the client, etc. You'll
+       find the ASN.1 Compiler for YAZ here as well (yc.tcl).
 
-odr     - Open Data Representation. This module implements the BER
+odr    - Open Data Representation. This module implements the BER
        encoding rules. Documentation is found in the files odr-use.man
        and odr.txt.
 
@@ -97,6 +101,13 @@ asn     - This module implements the Z39.50/SR protocol. The best way
        which defines structure and type definitions for each of the
        types introduced in the protocol specification.
 
+z39.50 - This module implements the Z39.50 protocol. This module
+        does the same job as the 'asn' module except that the source
+        files are auto-generated using an YAZ' ASN.1 Compiler (YC).
+
+zutil  - This module implements a collection of Z39.50 utilities, such
+        as query parsing, EXTERNAL handling, etc.
+
 comstack- This module implements the transport transparency
        stack (COMSTACK). The comstack implements a generic interface
        for exchanging BER-encoded records over a network. It supports
@@ -115,7 +126,7 @@ rfc1006 - Xtimosi requires an implementation of the OSI transport
 server  - This is the implementation of the server frontend. It
        provides event-handling and server managament functions,
        and calls the backend primitives (best documentation of these
-       is in the file include/backend.h). See server.txt.
+       is in the file include/backend.h).
 
 client  - A demonstration client. If we come upon a good design for a
        higher level client API, that will live here.