Add simple CLI program
[yaz4j-moved-to-github.git] / README
1 COMPILATION
2
3 Unix
4 ----
5
6 You will need the JDK, Maven, Swig and YAZ development packages.
7 Consult your package manager on how to install those.
8
9 'yaz-config' is assumed to be on the PATH, if it isn't or if local yaz
10 installation is to be used, its location can be forced with:
11
12 mvn -Dyaz.config=/path/to/yaz-config install
13
14
15 Windows
16 -------
17
18 Besides the exact same requirements as in the Unix case, you will need
19 the Windows SDK installed (which in turn requires .NET Framework 4).
20
21 Sensible default is assumed for 'yaz.path' but the 'swig' binary path has
22 hard-coded version number (see yaz4j/pom.xml) which most likely will need to
23 be updated to match your Swig version. Both can be overriden through:
24
25 mvn -Dyaz.path=/path/to/yaz/installation -Dswig=/path/to/swig/binary install
26
27 Use the command prompt provided with the Windows SDK. Yaz/bin directory must
28 be on the PATH.
29
30
31 Links
32 -----
33
34 The following is most probably already outdated, consult Google.
35
36 * JDK 
37   http://www.oracle.com/technetwork/java/javase/downloads/index.html
38
39 * Maven
40   http://maven.apache.org/download.cgi
41
42 * Swig
43   http://www.swig.org/download.html
44
45 * YAZ
46   http://www.indexdata.com/yaz
47
48 * Windows SDK
49   http://www.microsoft.com/en-us/download/details.aspx?id=8279