X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=54ba1b35de8f2391019a013b1f3a62f48eaf55eb;hb=45fa8afc47499349a694bc1d68ccfd947dda90aa;hp=e4b4b2dbe6b99729ceba3f324216d09bd00df822;hpb=fb5fa110fec362dba7c9818ed18d0131161c9a1a;p=yaz4j-moved-to-github.git

diff --git a/README b/README
index e4b4b2d..54ba1b3 100644
--- a/README
+++ b/README
@@ -1,29 +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 is a two-step process. The environment variable JAVA_HOME
-should point to the Java JDK of your preference. For example,
-  export JAVA_HOME=/usr/lib/jvm/java-6-sun
 
-Build the shared libary (.so) with:
-  cd libyaz4j
-  ./build.sh
+Windows
+-------
 
-Rest is built by maven which reads pom.xml:
-  cd ..
-  mvn compile
+Besides the exact same requirement as in the unix case, you will need
+the Windows SDK installed (which in turn requires .NET Framework 4).
 
-If you network-connected you should be able to run tests with:
-  mvn test
+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.