Add win32/64 build file

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

diff --git a/README b/README
index 00262cd..54ba1b3 100644 (file)
--- a/README
+++ b/README
@@ -1,25 +1,26 @@
-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 it's 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 requirement as in the unix case, you will need
+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:
+
+mvn -Dyaz.path=/path/to/yaz/installation -Dswig=/path/to/swig/binary install
+
+Use the command prompt provided with the Windows SDK.