README.md

   1 This is libzip, a C library for reading, creating, and modifying zip
   2 archives.  Files can be added from data buffers, files, or compressed
   3 data copied directly from other zip archives.  Changes made without
   4 closing the archive can be reverted.  The API is documented by man
   5 pages.
   6
   7 For more information, take a look at the included man pages.  You can
   8 start with [libzip(3)](http://nih.at/libzip/libzip.html), which lists
   9 all others.  Example source code is in the `src/` subdirectory.
  10
  11 If you have developed an application using libzip, you can find out
  12 about API changes and how to adapt your code for them in the included
  13 file `API-CHANGES`.
  14
  15 For generic installation instructions, see file `INSTALL`, which
  16 describes the approach using autoconf; alternatively, you can
  17 use cmake to build.
  18
  19 Additionally, you'll need zlib (at least version 1.1.2). It comes
  20 with most operating systems nowadays, or you can get it at
  21 >       http://www.zlib.net/
  22
  23 When using a static Windows library, you need to define `ZIP_STATIC`
  24 when compiling packages using libzip.
  25
  26 If you make a binary distribution, please include a pointer to the
  27 distribution site:
  28 >       http://www.nih.at/libzip/
  29
  30 The latest version can always be found there.
  31
  32 There is a mailing list for developers using libzip.  You can
  33 subscribe to it by sending a mail with the subject "subscribe
  34 libzip-discuss" to minimalist at nih.at. List mail should be sent
  35 to libzip-discuss at nih.at. Use this for bug reports or questions.
  36
  37 If you want to reach the authors in private, use <libzip@nih.at>.
  38
  39 ![Travis Build Status](https://api.travis-ci.org/nih-at/libzip.svg?branch=master)