Added a INSTALL file

[simpleserver-moved-to-github.git] / INSTALL

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..c817d8b
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,51 @@
+Building and installation
+-------------------------
+
+
+1. Requirements
+
+The Net::Z3950::SimpleServer Perl module requires the YAZ toolkit
+in the development version 1.7. You can download it via this link,
+
+       http://ftp.indexdata.dk/pub/yaz/development/
+
+You need to configure the YAZ toolkit with the command
+
+       % ./configure --enable-shared
+
+Then compile and install
+
+       % make
+       # make install
+
+You don't *need* to install YAZ globally on your machine if you
+prefer not to. In this case, you just have to update the Makefile.PL
+with the locations of the libraries.
+
+2. Installation
+
+Unpack the tar ball this way
+
+       % gunzip Net-Z3950-SimpleServer-xxxx.tar.gz
+       % tar xvf Net-Z3950-SimpleServer-xxxx.tar.gz
+
+and cd to the root directory of the module package
+
+       % cd Net-Z3950-SimpleServer-xxxx
+
+The installation takes place by issuing the following commands:
+
+       % perl Makefile.PL
+       % make
+       % make test
+       # make install
+
+The last command has to be issued as super user.
+
+Good luck!
+
+Anders Sønderberg <sondberg@indexdata.dk>
+http://www.indexdata.dk/
+
+
+