Merge branch 'master' of ssh://git.indexdata.com/home/git/pub/yaz4j

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

diff --git a/README b/README
index 644f324..c0629ca 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,13 @@
+COMPILATION
+
 Unix
 ----
 
-'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:
+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
+installation is to be used, its location can be forced with:
 
 mvn -Dyaz.config=/path/to/yaz-config install
 
@@ -10,11 +15,49 @@ mvn -Dyaz.config=/path/to/yaz-config install
 Windows
 -------
 
-Sensible defaults are assumed for 'yaz.path' and 'swig' binary. Both
-can be overriden though
+Besides the exact same requirements as in the Unix case, you will need
+the Windows SDK installed (which in turn requires .NET Framework 4).
+
+Sensible default is assumed for 'yaz.path' but the 'swig' binary path has
+hard-coded version number (see yaz4j/pom.xml) which most likely will need to
+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.
+
+
+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
 
-Visual Studio binaries must be available on the path, see 
-http://msdn.microsoft.com/en-us/library/f2ccy3wt%28v=VS.90%29.aspx
+* Windows SDK
+  http://www.microsoft.com/en-us/download/details.aspx?id=8279