README.md

   1 # dictzip-java
   2
   3 DictZip, GZip random access compression format(.dz), access library for Java
   4
   5 [![Build Status](https://travis-ci.org/dictzip/dictzip-java.svg?branch=master)](https://travis-ci.org/dictzip/dictzip-java)
   6 [![Download](https://api.bintray.com/packages/dictzip/maven/dictzip-lib/images/download.svg) ](https://bintray.com/dictzip/maven/dictzip-lib/_latestVersion)
   7
   8 ## Usage
   9
  10 Extract archive in directory. If you want to use just library, `dictzip-lib.jar`
  11 is an only file for you.
  12 CLI is also made for example of API usage and will be a good reference.
  13 Also there is a javadoc of DictZip at https://miurahr.github.io/dictzip-java
  14
  15 ### from maven/gradle
  16
  17 dictzip library is registered at JCenter repository. You can download
  18 from JCenter specifying as follows:
  19
  20 ```
  21 org.dict.zip:dictzip-lib:0.8.2
  22 ```
  23
  24 ## Build
  25
  26 DictZip for java uses Gradle for build system. You can build library and CLI
  27 by typing command:
  28
  29 ```
  30 $ gradle build
  31 ```
  32
  33 You will find archive files at
  34
  35 ```
  36 dictzip-cli/build/distributions/dictzip-<version>.tgz
  37 dictzip-cli/build/distributions/dictzip-<version>.zip
  38 ```
  39
  40 ## Contribution
  41
  42 As usual of other projects hosted on GitHub, DictZip for java also welcome
  43 forking source and send modification as a Pull Request.
  44 It is recommended to post an issue before sending a patch.
  45
  46
  47 ## Dependencies
  48
  49 DictZip library does not depend on any project without Java standard libraries.
  50
  51 DictZip CLI utility depends on some libraries.
  52 It depends on JFrog bintray JCenter repository.
  53
  54 ### Runtime depenency
  55
  56 - java-getopts library(GPLv2+)
  57
  58 ### Test dependency
  59
  60 - TestNG framework(Apache2)
  61 - Northside IO library(Apache2)
  62
  63
  64 ## Copyrights and License
  65
  66 DictZip library for Java and command line utility.
  67
  68 Copyright (C) 2001-2004 Ho Ngoc Duc
  69
  70 Copyright (C) 2016 Hiroshi Miura
  71
  72 Some part of this program are come from a part of jdictd 1.5 on java.
  73
  74 DictZip command line utility is distributed under the terms of GNU General
  75 Public License Version 2 or (at your option) any later version.
  76
  77 DictZip library is distributed under the terms of the GNU General Public License
  78 Version 2 or (at your option) any later version with the following clarification
  79 and special exception as same as GNU classpath.
  80
  81 Linking this library statically or dynamically with other modules is making
  82 a combined work based on this library. Thus, the terms and conditions of
  83 the GNU General Public License cover the whole combination.
  84
  85 As a special exception, the copyright holders of this library give you permission
  86 to link this library with independent modules to produce an executable, regardless
  87 of the license terms of these independent modules, and to copy and distribute
  88 the resulting executable under terms of your choice, provided that you also meet,
  89 for each linked independent module, the terms and conditions of the license of
  90 that module. An independent module is a module which is not derived from or based on
  91 this library. If you modify this library, you may extend this exception to
  92 your version of the library, but you are not obligated to do so. If you do not wish
  93 to do so, delete this exception statement from your version.
  94
  95 As such, it can be used to run, create and distribute a large class of applications
  96 and applets. When this library is used unmodified as the core class library
  97 for a virtual machine, compiler for the java languge, or for a program written
  98 in the java programming language it does not affect the licensing for distributing
  99 those programs directly.