X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=ce264f75db1469deb1da027969ac191f91206cf5;hb=51ac9b6a2e6170b6f836cb669dca5aaf7153a977;hp=00262cdca37bd8e6a190522a53251fd0164aff85;hpb=aec620258c1110cf27ae097c1e1a1303aff21d6c;p=yaz4j-moved-to-github.git

diff --git a/README b/README
index 00262cd..ce264f7 100644
--- a/README
+++ b/README
@@ -1,25 +1,49 @@
-yaz4j is a Java wrapper for the ZOOM API of YAZ. This allows developers
-to write Z39.50 clients in Java.
+COMPILATION
 
-yaz4j is distributed under the revised BSD license.
+Unix
+----
 
-Copyright (C) 2006-2007, Talis.
-Copyright (C) 2008-2009, Index Data.
-See LICENSE for details.
+You will need the JDK, Maven, Swig and YAZ development packages.
+Consult your package manager on how to install those.
 
-In order to built yaz4j the Java JDK, Maven, YAZ and Swig must be installed.
-The exact process varies from platform to platform.
+'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:
 
-For example, on Ubuntu/Debian the following installs the components:
-  apt-get install sun-java6-jdk maven2 libyaz3-dev swig
+mvn -Dyaz.config=/path/to/yaz-config install
 
-The compilation for native code (JNI) is performed by good old make.
-Adjust libyaz4j/Makefile as necessary. Tune JAVA_HOME and perhaps path to
-yaz-config in the Makefile.
 
-The Maven pom.xml will automatically invoke libyaz4j/Makefile , so
-this is what it takes:
-  mvn compile
+Windows
+-------
 
-If you network-connected you should be able to run tests with:
-  mvn test
+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. Yaz/bin directory must
+be on the 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