X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=7e6aafefbf21812d068cd2ba59f1c705a42dcfd6;hb=1b6019ff065a98af709be905adc6c08094471d57;hp=c4124fd216e15e61fa496c61f97dbad67e4c9663;hpb=779c379c70bf479073cc4968f6bf5ad35ffe6eec;p=yazpp-moved-to-github.git diff --git a/README b/README index c4124fd..7e6aafe 100644 --- a/README +++ b/README @@ -1,28 +1,32 @@ -YAZ++ - A C++ library for YAZ +YAZ++ - A C++ library for YAZ and a ZOOM C++ API. -$Id: README,v 1.1 2004-03-29 20:00:07 adam Exp $ - +$Id: README,v 1.5 2004-03-31 21:30:45 mike Exp $ Introduction ------------ -YAZ++ is a C++ layer for YAZ and implements the ANSI Z39.50 -protocol for information retrieval (client and server side). -The YAZ++ homepage is: http://www.indexdata.dk/yaz++/ +YAZ++ is a set of libraries and header files that make it easier to +use the the YAZ toolkit from C++, together with some utilities written +using these libraries. It includes an implementation of the C++ binding +for ZOOM and a powerful general-purpose Z39.50/SRW/SRU proxy. -YAZ++ uses the same license as YAZ - see LICENSE file for details. +YAZ++ and ZOOM C++ use the same BSD-like license as YAZ - see LICENSE +file for details. + +The proxy application and development library is covered by the +GPL - see LICENSE.proxy for details. Documentation ------------- -Directory sub contains documentation in HTML and PDF. You can -also read it online at http://www.indexdata.dk/yaz++/ +The "doc" directory contains documentation in HTML and PDF. +You can also read it online at http://www.indexdata.dk/yaz++/ Overview -------- YAZ++ builds a programmers' library libyaz++.lib and a few -example applications: +applications: yaz-my-client basic client yaz-my-server basic server @@ -30,12 +34,15 @@ example applications: Directory structure of the YAZ++ package: - -- src (C++ library and proxy source) + -- src (C++ library) -- zoom (C++ source for ZOOM) + -- proxy (C++ source for proxy) -- include/yaz++ (C++ headers) + -- include/yaz++/proxy (C++ headers for proxy) -- lib (compiled libraries) -- win (Windows build files) -- doc (DocBook-format documentation) + -- etc (Proxy config + XSLT files) Installation, Unix ------------------ @@ -60,15 +67,15 @@ version of that as well (not just the runtime). Libxml2/libxslt can also be compiled easily on most systems. See http://www.xmlsoft.org/ for more information. -Then, build YAZ++: +Then build YAZ++: $ cd yaz++- $ ./configure $ make If you do have libxslt installed and configure above does not find it, -use option --with-xslt=PREFIX to specify location of libxslt and libxml2. -yaz++ configure looks for PREFIX/bin/xslt-config. +use option --with-xslt=PREFIX to specify location of libxslt (which includes +libxml2). The configure script looks for PREFIX/bin/xslt-config. Installation, Windows --------------------- @@ -84,7 +91,6 @@ those compilers. yazserver.dsp - builds yazmyserver.exe yazproxy.dsp - builds yazproxy.exe - About the proxy ---------------