granicus.if.org Git - zziplib/blob - README

   1 PROJECT
   2   The zziplib provides read access to zipped files in a zip-archive,
   3   using compression based solely on free algorithms provided by zlib.
   4   It also provides a functionality to overlay the archive filesystem
   5   with the filesystem of the operating system environment.
   6
   7 AUTHOR
   8   The project was originally written by Tomi Ollila, later largely
   9   rewritten by Guido Draheim, and extended with contributions in
  10   the years to follow. Guido Draheim <guidod@gmx.de> holds the full
  11   copyright to the zziplib sources.
  12
  13 COPYING
  14   The zziplib may be used freely under the restrictions of the
  15   GNU Lesser General Public License version 2 or later. Alternatively
  16   the Mozilla Public license can be chosen. The sources are under
  17   a dual license, as long as the MPL hint is not removed, the modified
  18   files will be again under a dual license for the final recipient.
  19
  20 LICENSING
  21   If you can not use a dynalinked library according to LGPL rules,
  22   then look at docs/copying.htm for a few hints. Generally the LGPL
  23   has a way for staticlinking as well as the MPL has a way. Anyway,
  24   special (paid) licenses can be negotiated with the copyright holder.
  25
  26 HOMEPAGE
  27   The zziplib project has moved to GitHub where you can find the
  28   last release tags now => https://github.com/gdraheim/zziplib
  29   The zziplib project was originally hosted at SourceForge with
  30   the documentation at http://zziplib.sf.net - this is a bit
  31   outdated but the API has not changed much since then. To get
  32   the latest release announcements, watch the GitHub project.
  33
  34 INSTALLATION
  35   The zziplib sources are built with cmake. This allows to build it
  36   easily with make / ninja on unixish systems via the usual sequence of
  37   `cmake3 && make && make check && make install`. Many distributors
  38   ship prebuilt packages e.g. in rpm format. Additionally cmake allows
  39   to generate MSVC project files - the old ones will be dropped soon.
  40   There should be no problem either when crosscompiling the zziplib
  41   for a third host platform.
  42
  43 MAINTENANCE
  44   The zziplib library is intentionally a lightweight interface to
  45   zip files. The author take patches but please consider to put
  46   complex extensions into separate modules rather than implanting them
  47   right into the core of the library engine. All Patches and Bug Reports
  48   should be sent to Guido Draheim <guidod@gmx.de>.