Package#send throws ZoomException YAZJ-18

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

diff --git a/README b/README
index d27f59b..84a692d 100644 (file)
--- a/README
+++ b/README
@@ -3,11 +3,11 @@ COMPILATION
 Unix
 ----
 
 Unix
 ----
 

-You will need the JDK, maven, swig and yaz development packages.
+You will need the JDK, Maven, Swig and YAZ development packages.

 Consult your package manager on how to install those.
 
 'yaz-config' is assumed to be on the PATH, if it isn't or if local yaz
 Consult your package manager on how to install those.
 
 'yaz-config' is assumed to be on the PATH, if it isn't or if local yaz

-installation is to be used it's location can be forced with:
+installation is to be used, its location can be forced with:

 
 mvn -Dyaz.config=/path/to/yaz-config install
 
 
 mvn -Dyaz.config=/path/to/yaz-config install
 

@@ -15,13 +15,49 @@ mvn -Dyaz.config=/path/to/yaz-config install
 Windows
 -------
 
 Windows
 -------
 

-Besides the exact same requirement as in the unix case, you will need
+Besides the exact same requirements as in the Unix case, you will need

 the Windows SDK installed (which in turn requires .NET Framework 4).
 
 the Windows SDK installed (which in turn requires .NET Framework 4).
 

-Sensible defaults are assumed for 'yaz.path' and the 'swig' binary. Both
-can be overriden through:
+Sensible default is assumed for 'yaz.path'. 'swig' is set without path
+so either specify absolute path or update the PATH environment to include
+directory holding swig.exe. Both can be overriden through:

 
 mvn -Dyaz.path=/path/to/yaz/installation -Dswig=/path/to/swig/binary install
 
 
 mvn -Dyaz.path=/path/to/yaz/installation -Dswig=/path/to/swig/binary install
 

-Use the command prompt provided with the Windows SDK. Yaz/bin directory must
-be on the Path.
+Use the command prompt provided with the Windows SDK.
+
+
+RUNNING A TEST PROGRAM
+
+A trivial test program is included in the yaz4.jar, you can invoke it to check
+the sanity of your yaz4j compilation/installation. On Windows, the YAZ/bin 
+directory (default "C:\Porgam Files\YAZ\bin", if you are using YAZ installer) 
+MUST be on the PATH, otherwise dependent shared libraries will fail to load. 
+Run:
+
+  java -Djava.library.path=/path/to/yaz4j/dll/or/so/dir -jar any/target/yaz4j.jar
+
+Where "/path/to/yaz4j/dll/or/so/dir" points to the directory containing the
+native yaz4j libary (Windows -> yaz4j/win32/target, Unix -> yaz4j/unix/target).
+You can omit this flag, if your yaz4j.dll/so is already available on the 
+library path.
+
+
+LINKS
+
+The following is most probably already outdated, consult Google.
+
+* JDK 
+  http://www.oracle.com/technetwork/java/javase/downloads/index.html
+
+* Maven
+  http://maven.apache.org/download.cgi
+
+* Swig
+  http://www.swig.org/download.html
+
+* YAZ
+  http://www.indexdata.com/yaz
+
+* Windows SDK
+  http://www.microsoft.com/en-us/download/details.aspx?id=8279