README.md

   1 # dictzip-java
   2 DictZip, GZip random access compression format(.dz), access library for Java
   3
   4 ## Usage
   5
   6 Extract archive in directory. If you want to use just library, `dictzip-lib.jar`
   7 is an only file for you.
   8 CLI is also made for example of API usage and will be a good reference.
   9 Also there is a javadoc of DictZip at https://miurahr.github.io/dictzip-java
  10
  11 ## Build
  12
  13 DictZip for java uses Gradle for build system. You can build library and CLI
  14 by typing command:
  15
  16 ```
  17 $ gradle build
  18 ```
  19
  20 You will find archive files at
  21
  22 ```
  23 dictzip-cli/build/distributions/
  24 ```
  25
  26 ## Contribution
  27
  28 As usual of other projects hosted on GitHub, DictZip for java also welcome
  29 forking source and send modification as a Pull Request.
  30 It is recommended to post an issue before sending a patch.
  31
  32
  33 ## Dependencies
  34
  35 DictZip library does not depend on any project without Java standard libraries.
  36
  37 DictZip CLI utility depends on some libraries.
  38
  39 ### Runtime depenency
  40
  41 - java-getopts library(GPLv2+)
  42 - Apache commons codec library(Apache2)
  43
  44 ### Test dependency
  45
  46 - TestNG framework(Apache2)
  47 - Apache commons IO library(Apache2)
  48
  49
  50 ## Copyrights and License
  51
  52 DictZip library for Java and command line utility.
  53
  54 Copyright (C) 2001-2004 Ho Ngoc Duc
  55 Copyright (C) 2016 Hiroshi Miura
  56
  57 Some part of this program code are come from a part of abandoned jdictd on java
  58 by JDictd project.
  59
  60 DictZip command line utility is distributed under the terms of GNU General
  61 Public License Version 3 or (at your option) any later version.
  62
  63 DictZip library is distributed under the terms of the GNU General Public License
  64 Version 2 or (at your option) any later version.