README.md

   1 # dictzip
   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
   7
   8 ## Usage
   9
  10
  11 dictzip library is published on MavenCentral. When you use with gradle build system,
  12 just add a dependency.
  13
  14 ```
  15 dependencies {
  16     implementation 'io.github.dictzip:dictzip:0.11.1'
  17 }
  18 ```
  19
  20 ## Contribution
  21
  22 As usual of other projects hosted on GitHub, DictZip for java also welcome
  23 forking source and send modification as a Pull Request.
  24 It is recommended to post an issue before sending a patch.
  25
  26
  27 ## Copyrights and License
  28
  29 DictZip library for Java and command line utility.
  30
  31 Copyright (C) 2001-2004 Ho Ngoc Duc
  32
  33 Copyright (C) 2016-2022 Hiroshi Miura
  34
  35 Some part of this program are come from a part of jdictd 1.5 on java.
  36
  37 DictZip command line utility is distributed under the terms of GNU General
  38 Public License Version 2 or (at your option) any later version.
  39
  40 DictZip library is distributed under the terms of the GNU General Public License
  41 Version 2 or (at your option) any later version with the following clarification
  42 and special exception as same as GNU classpath.
  43
  44 Linking this library statically or dynamically with other modules is making
  45 a combined work based on this library. Thus, the terms and conditions of
  46 the GNU General Public License cover the whole combination.
  47
  48 As a special exception, the copyright holders of this library give you permission
  49 to link this library with independent modules to produce an executable, regardless
  50 of the license terms of these independent modules, and to copy and distribute
  51 the resulting executable under terms of your choice, provided that you also meet,
  52 for each linked independent module, the terms and conditions of the license of
  53 that module. An independent module is a module which is not derived from or based on
  54 this library. If you modify this library, you may extend this exception to
  55 your version of the library, but you are not obligated to do so. If you do not wish
  56 to do so, delete this exception statement from your version.
  57
  58 As such, it can be used to run, create and distribute a large class of applications
  59 and applets. When this library is used unmodified as the core class library
  60 for a virtual machine, compiler for the java languge, or for a program written
  61 in the java programming language it does not affect the licensing for distributing
  62 those programs directly.