A note on running the test program
authorJakub Skoczen <jakub@indexdata.dk>
Mon, 15 Apr 2013 09:14:54 +0000 (11:14 +0200)
committerJakub Skoczen <jakub@indexdata.dk>
Mon, 15 Apr 2013 09:14:54 +0000 (11:14 +0200)
README

diff --git a/README b/README
index ce264f7..c0629ca 100644 (file)
--- a/README
+++ b/README
@@ -24,12 +24,26 @@ be updated to match your Swig version. Both can be overriden through:
 
 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.
 
 
-Links
------
+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.