blob: e5bb5d81b00c3eea26bfb066c85d6cb4d235d204 [file] [log] [blame] [view]
Dieter Baron95a0fa32016-02-17 12:29:25 +01001This is libzip, a C library for reading, creating, and modifying zip
Thomas Klausner38d1c352016-12-18 11:36:08 +01002archives. Files can be added from data buffers, files, or compressed
3data copied directly from other zip archives. Changes made without
4closing the archive can be reverted. Decryption and encryption of
5Winzip AES and decryption of legacy PKware encrypted files is
6supported. The API is documented by man pages.
Dieter Baron95a0fa32016-02-17 12:29:25 +01007
Thomas Klausnerf423dd22016-02-17 13:58:57 +01008For more information, take a look at the included man pages. You can
9start with [libzip(3)](http://nih.at/libzip/libzip.html), which lists
10all others. Example source code is in the `src/` subdirectory.
Dieter Baron95a0fa32016-02-17 12:29:25 +010011
12If you have developed an application using libzip, you can find out
13about API changes and how to adapt your code for them in the included
Thomas Klausnerf423dd22016-02-17 13:58:57 +010014file `API-CHANGES`.
Dieter Baron95a0fa32016-02-17 12:29:25 +010015
Thomas Klausnerf423dd22016-02-17 13:58:57 +010016For generic installation instructions, see file `INSTALL`, which
Dieter Baron95a0fa32016-02-17 12:29:25 +010017describes the approach using autoconf; alternatively, you can
18use cmake to build.
19
20Additionally, you'll need zlib (at least version 1.1.2). It comes
21with most operating systems nowadays, or you can get it at
22> http://www.zlib.net/
23
Thomas Klausnerf423dd22016-02-17 13:58:57 +010024When using a static Windows library, you need to define `ZIP_STATIC`
Dieter Baron95a0fa32016-02-17 12:29:25 +010025when compiling packages using libzip.
26
27If you make a binary distribution, please include a pointer to the
28distribution site:
29> http://www.nih.at/libzip/
Dieter Baron9f7152e2016-02-17 12:31:40 +010030
Dieter Baron95a0fa32016-02-17 12:29:25 +010031The latest version can always be found there.
32
33There is a mailing list for developers using libzip. You can
34subscribe to it by sending a mail with the subject "subscribe
35libzip-discuss" to minimalist at nih.at. List mail should be sent
36to libzip-discuss at nih.at. Use this for bug reports or questions.
37
38If you want to reach the authors in private, use <libzip@nih.at>.
Thomas Klausnerd9c31262016-02-17 12:38:13 +010039
40![Travis Build Status](https://api.travis-ci.org/nih-at/libzip.svg?branch=master)
Thomas Klausner8f07abe2016-12-02 15:40:36 +010041![Coverity Status](https://scan.coverity.com/projects/127/badge.svg?flat=1)