Omit tkl rules for documentation
[yaz-moved-to-github.git] / README
1 YAZ toolkit
2
3 Copyright (C) 1995-2009 Index Data ApS.
4 See the file LICENSE for details.
5
6 The primary output of the source here is the YAZ library, which
7 contains support functions for implementing the server or client
8 role of Z39.50 and SRU.
9
10 On Unix, GNU configure is used to configure YAZ and generate Makefiles.
11 Type "./configure", then "make" to build YAZ. Read
12 doc/installation.unix.html for details.
13
14 On Windows, a MS Visual Studio makefile is provided (nmake). The commands
15   cd \win
16   nmake
17 should do. Refer to doc/installation.win32.html for details.
18
19 Note: If you are using the Git snapshot of YAZ you must have autoconf,
20 automake, libtool and xsltproc installed. Before running configure, create
21 support files by running buildconf.sh in the top-level directory of YAZ.  
22
23 In any case refer to the documentation in sub directory doc or read
24 it online at http://www.indexdata.com/yaz/
25
26 File organisation:
27
28 doc      Documentation.
29
30 src      Source for the YAZ library.
31
32 util     Utility programs, ASN.1 compiler, MARC dump utility, and others.
33
34 client   A demonstration client for testing the protocol. It's bug'n
35          ugly. But, it supports many features.
36
37 ztest    A demonstration server that implements a backend.
38
39 etc      Various configuration files.
40
41 include/yaz The various header files.
42
43 To get more information or assistance, send mail to yaz-help@indexdata.dk.
44 Even better, sign on to the YAZ mailing list here:
45 http://lists.indexdata.dk/cgi-bin/mailman/listinfo/yazlist
46