documentation cleanup
[irspy-moved-to-github.git] / README
diff --git a/README b/README
index 76e425b..b28e0dc 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
-$Id: README,v 1.2 2006-07-21 11:24:20 mike Exp $
+$Id: README,v 1.6 2007-04-18 15:22:48 mike Exp $
 
-Net-Z3950-IRSpy
-===============
+ZOOM::IRSpy
+===========
 
 This module exists to implement the IRspy program, which discovers,
 analyses and monitors IR servers implementing the Z39.50 and SRU/W
@@ -9,6 +9,34 @@ protocols.  It is a successor to the ZSpy program.
 
 INSTALLATION
 
+for debian/ubuntu:
+-------------------
+
+DEBIAN DEPENDENCIES
+
+If you have a Debian-based operating system, you can get what you need
+by installing the following packages from the operating system's
+package store, using apt-get:
+
+sudo apt-get install \
+       libnet-z3950-zoom-perl \
+       libxml-libxml-common-perl \
+       liburi-perl \
+       libxml-libxml-perl \
+       libapache2-mod-perl2 \
+       libhtml-mason-perl \
+       libapache2-request-perl \
+       libapache2-mod-apreq2 \
+       libxml-libxslt-perl \
+       idzebra-2.0 \
+
+you may need one of the following packages for development:
+
+sudo apt-get install \
+       make perl-doc
+
+
+
 To install this module type the following:
 
    perl Makefile.PL
@@ -33,6 +61,10 @@ at your option, any later version of Perl 5 you may have available.
 
 --
 
-Note to self: everyone else please ignore this.
-$ cd /usr/local/src/cvs/irspy && YAZ_LOG=irspy,irspy_test,irspy_debug,pod perl -I lib bin/irspy.pl -t "bagel.indexdata.dk/gils foo.bar.baz:12345/fish z3950.loc.gov:7090/Voyager" localhost:1313/IR-Explain---1
+Notes to self: everyone else please ignore these
+
+$ cd /usr/local/src/cvs/irspy && YAZ_LOG=irspy,irspy_test,irspy_debug,pod perl -I lib bin/irspy.pl -t "bagel.indexdata.dk/gils foo.bar.baz:12345/fish z3950.loc.gov:7090/Voyager" localhost:8018/IR-Explain---1
+
+To get a list of all Danish domains in the database:
+.../ZOOM-Perl/samples/zoom/zselect -t q localhost:8018/IR-Explain---1 'net.host = *.dk' //zeerex:host